001: /*
002: * $Id: BinaryExchange.java,v 1.2 2007/05/29 22:11:30 ofung Exp $
003: */
004:
005: /*
006: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
007: *
008: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
009: *
010: * The contents of this file are subject to the terms of either the GNU
011: * General Public License Version 2 only ("GPL") or the Common Development
012: * and Distribution License("CDDL") (collectively, the "License"). You
013: * may not use this file except in compliance with the License. You can obtain
014: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
015: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
016: * language governing permissions and limitations under the License.
017: *
018: * When distributing the software, include this License Header Notice in each
019: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
020: * Sun designates this particular file as subject to the "Classpath" exception
021: * as provided by Sun in the GPL Version 2 section of the License file that
022: * accompanied this code. If applicable, add the following below the License
023: * Header, with the fields enclosed by brackets [] replaced by your own
024: * identifying information: "Portions Copyrighted [year]
025: * [name of copyright owner]"
026: *
027: * Contributor(s):
028: *
029: * If you wish your version of this file to be governed by only the CDDL or
030: * only the GPL Version 2, indicate your decision by adding "[Contributor]
031: * elects to include this software in this distribution under the [CDDL or GPL
032: * Version 2] license." If you don't indicate a single choice of license, a
033: * recipient has the option to distribute your version of this file under
034: * either the CDDL, the GPL Version 2 or to extend the choice of license to
035: * its licensees as provided above. However, if you add GPL Version 2 code
036: * and therefore, elected the GPL Version 2 license, then the option applies
037: * only if the new code is made subject to such option by the copyright
038: * holder.
039: */
040:
041: package com.sun.xml.ws.security.trust.elements;
042:
043: import java.util.Map;
044: import javax.xml.namespace.QName;
045:
046: /**
047: *
048: * @author WS-Trust Implementation Team
049: */
050: public interface BinaryExchange {
051: /**
052: * Gets the value of the encodingType property.
053: *
054: * @return {@link String}
055: *
056: */
057: String getEncodingType();
058:
059: /**
060: * Gets a map that contains attributes that aren't bound to any typed property on this class.
061: *
062: * <p>
063: * the map is keyed by the name of the attribute and
064: * the value is the string value of the attribute.
065: *
066: * the map returned by this method is live, and you can add new attribute
067: * by updating the map directly. Because of this design, there's no setter.
068: *
069: *
070: * @return
071: * always non-null
072: */
073: Map<QName, String> getOtherAttributes();
074:
075: /**
076: * Gets the decoded value of the text node. This represents the
077: * raw bytes for the Binary Exchange.
078: *
079: * @return {@link byte[] }
080: *
081: */
082: byte[] getRawValue();
083:
084: /**
085: * Gets the value of the text node. This method will return the
086: * encoded value of the binary data exchanged. Encoding is specified
087: * with the encodingType attibute.
088: *
089: * @return {@link String}
090: * @see {getRawValue}
091: *
092: */
093: String getTextValue();
094:
095: /**
096: * Gets the value of the valueType property. ValueType contains the
097: * URI that identifies the type of negotiation.
098: *
099: * @return {@link String }
100: *
101: */
102: String getValueType();
103:
104: /**
105: * Sets the value of the encodingType property.
106: *
107: * @param encodingType {@link String}
108: *
109: */
110: void setEncodingType(String encodingType);
111:
112: /**
113: * Sets the value of the text node. It is assumed that the
114: * proper encoding has already been taken care of to create the
115: * text value.
116: *
117: * @param encodedText {@link String }
118: *
119: */
120: void setTextValue(String encodedText);
121:
122: /**
123: * Sets the value of the binary exchange as raw bytes.
124: * The value that appears in the element will be encoded appropriately.
125: *
126: * @param rawText {@link byte[]}
127: *
128: */
129: void setRawValue(byte[] rawText);
130:
131: /**
132: * Sets the value of the valueType property.
133: *
134: * @param valueType {@link String}
135: *
136: */
137: void setValueType(String valueType);
138:
139: }
|