001: /*
002: * $Id: Entropy.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.List;
044: import java.util.Map;
045: import javax.xml.namespace.QName;
046:
047: import com.sun.xml.ws.security.EncryptedKey;
048:
049: /**
050: *
051: * @author WS-Trust Implementation Team
052: */
053: public interface Entropy {
054:
055: /**
056: * Constants defining the Type of Entropy
057: */
058: public static final String BINARY_SECRET_TYPE = "BinarySecret";
059: public static final String ENCRYPTED_KEY_TYPE = "EncryptedKey";
060: public static final String CUSTOM_TYPE = "Custom";
061:
062: /**
063: *Gets the type of the Entropy contents
064: */
065: String getEntropyType();
066:
067: /**
068: *Sets the type of the Entropy contents
069: */
070: void setEntropyType(String entropyType);
071:
072: /**
073: * Gets the value of the any property.
074: *
075: * <p>
076: * This accessor method returns a reference to the live list,
077: * not a snapshot. Therefore any modification you make to the
078: * returned list will be present inside the JAXB object.
079: * This is why there is not a <CODE>set</CODE> method for the any property.
080: *
081: * <p>
082: * For example, to add a new item, do as follows:
083: * <pre>
084: * getAny().add(newItem);
085: * </pre>
086: *
087: *
088: * <p>
089: * Objects of the following type(s) are allowed in the list
090: * {@link Element }
091: * {@link Object }
092: *
093: *
094: */
095: List<Object> getAny();
096:
097: /**
098: * Gets a map that contains attributes that aren't bound to any typed property on this class.
099: *
100: * <p>
101: * the map is keyed by the name of the attribute and
102: * the value is the string value of the attribute.
103: *
104: * the map returned by this method is live, and you can add new attribute
105: * by updating the map directly. Because of this design, there's no setter.
106: *
107: *
108: * @return
109: * always non-null
110: */
111: Map<QName, String> getOtherAttributes();
112:
113: /** Gets the BinarySecret (if any) inside this Entropy
114: * @return BinarySecret if set, null otherwise
115: */
116: BinarySecret getBinarySecret();
117:
118: /**
119: * Sets the BinarySecret (if any) inside this Entropy
120: */
121: void setBinarySecret(BinarySecret binarySecret);
122:
123: /**
124: * Gets the xenc:EncryptedKey set inside this Entropy instance
125: * @return xenc:EncryptedKey if set, null otherwise
126: */
127: EncryptedKey getEncryptedKey();
128:
129: /**
130: * Sets the xenc:EncryptedKey set inside this Entropy instance
131: */
132: void setEncryptedKey(EncryptedKey encryptedKey);
133:
134: }
|