View Javadoc

1   /*
2    * Copyright 2008 University Corporation for Advanced Internet Development, Inc.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.opensaml.ws.wsfed;
18  
19  import java.util.List;
20  
21  import javax.xml.namespace.QName;
22  
23  /**
24   * This interface defines how the object representing a WS RSTR <code> RequestedSecurityTokenResponse </code> element
25   * behaves.
26   */
27  public interface RequestSecurityTokenResponse extends WSFedObject {
28  
29      /** Element name, no namespace. */
30      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "RequestSecurityTokenResponse";
31  
32      /** Default element name. */
33      public static final QName DEFAULT_ELEMENT_NAME = new QName(WSFedConstants.WSFED11P_NS, DEFAULT_ELEMENT_LOCAL_NAME,
34              WSFedConstants.WSFED1P_PREFIX);
35  
36      /** Local name of the XSI type. */
37      public static final String TYPE_LOCAL_NAME = "RequestSecurityTokenResponseType";
38  
39      /** QName of the XSI type. */
40      public static final QName TYPE_NAME = new QName(WSFedConstants.WSFED11P_NS, TYPE_LOCAL_NAME,
41              WSFedConstants.WSFED1P_PREFIX);
42  
43      /**
44       * Gets the entity to which the token applies.
45       * 
46       * @return the entity to which the token applies
47       */
48      public AppliesTo getAppliesTo();
49  
50      /**
51       * Set the entity to which the token applies.
52       * 
53       * @param appliesTo the entity to which the token applies
54       */
55      public void setAppliesTo(AppliesTo appliesTo);
56  
57      /**
58       * Return the list of Security Token child elements.
59       * 
60       * @return the list of RequestedSecurityToken child elements.
61       */
62      public List<RequestedSecurityToken> getRequestedSecurityToken();
63  }