001: /*
002: * $Id: RequestedProofToken.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 com.sun.xml.ws.security.trust.elements.str.SecurityTokenReference;
044: import java.net.URI;
045:
046: /**
047: * @author WS-Trust Implementation Team.
048: */
049: public interface RequestedProofToken {
050:
051: /** constants indicating type of Proof Token
052: * @see getProofTokenType
053: */
054: public static final String COMPUTED_KEY_TYPE = "ComputedKey";
055: public static final String TOKEN_REF_TYPE = "SecurityTokenReference";
056: public static final String ENCRYPTED_KEY_TYPE = "EncryptedKey";
057: public static final String BINARY_SECRET_TYPE = "BinarySecret";
058: public static final String CUSTOM_TYPE = "Custom";
059:
060: /**
061: * Get the type of ProofToken present in this RequestedProofToken Instance
062: */
063: String getProofTokenType();
064:
065: /**
066: * Set the type of ProofToken present in this RequestedProofToken Instance
067: * @see getProofTokenType
068: */
069: void setProofTokenType(String proofTokenType);
070:
071: /**
072: * Gets the value of the any property.
073: *
074: * @return
075: * possible object is
076: * {@link Element }
077: * {@link Object }
078: *
079: */
080: Object getAny();
081:
082: /**
083: * Sets the value of the any property.
084: *
085: * @param value
086: * allowed object is
087: * {@link Element }
088: * {@link Object }
089: *
090: */
091: void setAny(Object value);
092:
093: /**
094: * Set a SecurityTokenReference as the Proof Token
095: */
096: void setSecurityTokenReference(SecurityTokenReference reference);
097:
098: /**
099: * Gets the SecrityTokenReference if set
100: * @return SecurityTokenReference if set, null otherwise
101: */
102: SecurityTokenReference getSecurityTokenReference();
103:
104: /**
105: *Sets the Computed Key URI (describing how to compute the Key)
106: */
107: void setComputedKey(URI computedKey);
108:
109: /**
110: *Get the Computed Key URI (describing how to compute the Key)
111: *@return computed key URI or null if none is set
112: */
113: URI getComputedKey();
114:
115: /**
116: * Sets a wst:BinarySecret as the Proof Token
117: */
118: void setBinarySecret(BinarySecret secret);
119:
120: /**
121: * Gets the BinarySecret proof Token if set
122: * @return BinarySecret if set, null otherwise
123: */
124: BinarySecret getBinarySecret();
125: }
|