View Javadoc

1   /*
2    * Copyright 2008 Members of the EGEE Collaboration.
3    * Copyright 2008 University Corporation for Advanced Internet Development, Inc.
4    *
5    * Licensed under the Apache License, Version 2.0 (the "License");
6    * you may not use this file except in compliance with the License.
7    * You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.opensaml.ws.wstrust;
18  
19  import java.util.List;
20  
21  import javax.xml.namespace.QName;
22  
23  import org.opensaml.xml.ElementExtensibleXMLObject;
24  
25  /**
26   * The wst:Participants element.
27   * 
28   * @see "WS-Trust 1.3, Chapter 9.5 Authorized Token Participants."
29   * 
30   */
31  public interface Participants extends ElementExtensibleXMLObject, WSTrustObject {
32  
33      /** Element local name. */
34      public static final String ELEMENT_LOCAL_NAME = "Participants";
35  
36      /** Default element name. */
37      public static final QName ELEMENT_NAME =
38          new QName(WSTrustConstants.WST_NS, ELEMENT_LOCAL_NAME, WSTrustConstants.WST_PREFIX);
39      
40      /** Local name of the XSI type. */
41      public static final String TYPE_LOCAL_NAME = "ParticipantsType"; 
42          
43      /** QName of the XSI type. */
44      public static final QName TYPE_NAME = 
45          new QName(WSTrustConstants.WST_NS, TYPE_LOCAL_NAME, WSTrustConstants.WST_PREFIX);
46  
47      /**
48       * Returns the wst:Primary child element.
49       * 
50       * @return the {@link Primary} child element or <code>null</code>.
51       */
52      public Primary getPrimary();
53  
54      /**
55       * Sets the wst:Primary child element.
56       * 
57       * @param primary the {@link Primary} child element to set.
58       */
59      public void setPrimary(Primary primary);
60  
61      /**
62       * Returns the list of wst:Participant child elements .
63       * 
64       * @return the list of {@link Participant} child elements
65       */
66      public List<Participant> getParticipants();
67  
68  }