com.sun.xml.ws.security.trust.elements.WSTrustElementBase Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
/*
* $Id: WSTrustElementBase.java,v 1.2 2010-10-21 15:35:41 snajper Exp $
*/
package com.sun.xml.ws.security.trust.elements;
import java.net.URI;
import com.sun.xml.ws.policy.impl.bindings.AppliesTo;
import com.sun.xml.ws.policy.Policy;
import com.sun.xml.ws.policy.impl.bindings.PolicyReference;
import com.sun.xml.ws.api.security.trust.WSTrustException;
/**
* @author WS-Trust Implementation Team.
*/
public interface WSTrustElementBase {
/**
* Get the type of security token, specified as a URI.
* @return {@link URI}
*/
URI getTokenType();
/**
* Set the type of security token, specified as a URI.
* @param tokenType {@link URI}
*/
void setTokenType(URI tokenType);
/**
* Get the desired LifeTime settings for the token if specified, null otherwise
*/
Lifetime getLifetime();
/**
* Set the desired lifetime settings for the requested token
*/
void setLifetime(Lifetime lifetime);
/**
* Get the entropy for the requested token
* @return {@link Entropy}
*/
Entropy getEntropy();
/**
* Set the entropy for the requested token
* @param entropy {@link Entropy}
*/
void setEntropy(Entropy entropy);
/**
* Set the desired policy settings for the requested token
* @param appliesTo {@link AppliesTo}
*/
void setAppliesTo(AppliesTo appliesTo);
/**
* Get the desired AppliesTo policy settings for the token if specified, null otherwise
* @return {@link AppliesTo}
*/
AppliesTo getAppliesTo();
/**
* Set the value of OnBehalfOf for the requested token
* @param appliesTo {@link OnBehalfOf}
*/
void setOnBehalfOf(OnBehalfOf onBehalfOf);
/**
* Get the value of OnBehalfOf for the token if specified, null otherwise
* @return {@link OnBehalfOf}
*/
OnBehalfOf getOnBehalfOf();
/**
* set Issuer of the SecurityToken Presented in the message
*/
void setIssuer(Issuer issuer);
/**
* get Issuer of the SecurityToken Presented in the Message, null otherwise
*/
Issuer getIssuer();
/**
* set a