View Javadoc

1   /*
2    * Copyright 2009 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.saml2.ecp;
18  
19  import javax.xml.namespace.QName;
20  
21  import org.opensaml.common.SAMLObject;
22  import org.opensaml.common.xml.SAMLConstants;
23  import org.opensaml.saml2.core.IDPList;
24  import org.opensaml.saml2.core.Issuer;
25  import org.opensaml.ws.soap.soap11.ActorBearing;
26  import org.opensaml.ws.soap.soap11.MustUnderstandBearing;
27  import org.opensaml.xml.schema.XSBooleanValue;
28  
29  /**
30   * SAML 2.0 ECP Request SOAP header.
31   */
32  public interface Request extends SAMLObject, MustUnderstandBearing, ActorBearing {
33      
34      /** Element local name. */
35      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "Request";
36  
37      /** Default element name. */
38      public static final QName DEFAULT_ELEMENT_NAME =
39          new QName(SAMLConstants.SAML20ECP_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML20ECP_PREFIX);
40  
41      /** Local name of the XSI type. */
42      public static final String TYPE_LOCAL_NAME = "RequestType";
43  
44      /** QName of the XSI type. */
45      public static final QName TYPE_NAME =
46          new QName(SAMLConstants.SAML20ECP_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML20ECP_PREFIX);
47  
48      /** ProviderName attribute name. */
49      public static final String PROVIDER_NAME_ATTRIB_NAME = "ProviderName";
50  
51      /** IsPassive attribute name. */
52      public static final String IS_PASSIVE_NAME_ATTRIB_NAME = "IsPassive";
53      
54      /**
55       * Get the Issuer child elemet.
56       * 
57       * @return the Issuer child element
58       */
59      public Issuer getIssuer();
60      
61      /**
62       * Set the Issuer child elemet.
63       * 
64       * @param newIssuer the new Issuer child element
65       */
66      public void setIssuer(Issuer newIssuer);
67      
68      /**
69       * Get the IDPList child element.
70       * 
71       * @return the IDPList child element
72       */
73      public IDPList getIDPList();
74      
75      /**
76       * Set the IDPList child element.
77       * 
78       * @param newIDPList the new IDPList child element
79       */
80      public void setIDPList(IDPList newIDPList);
81      
82      /**
83       * Get the ProviderName attribute value.
84       * 
85       * @return the ProviderName attribute value
86       */
87      public String getProviderName();
88      
89      /**
90       * Set the ProviderName attribute value.
91       * 
92       * @param newProviderName the new ProviderName attribute value
93       */
94      public void setProviderName(String newProviderName);
95      
96      /**
97       * Get the IsPassive attribute value.
98       * 
99       * @return the IsPassive attribute value
100      */
101     public Boolean isPassive();
102     
103     /**
104      * Get the IsPassive attribute value.
105      * 
106      * @return the IsPassive attribute value
107      */
108     public XSBooleanValue isPassiveXSBoolean();
109     
110     /**
111      * Set the IsPassive attribute value.
112      * 
113      * @param newIsPassive the new IsPassive attribute value
114      */
115     public void setPassive(Boolean newIsPassive);
116     
117     /**
118      * Set the IsPassive attribute value.
119      * 
120      * @param newIsPassive the new IsPassive attribute value
121      */
122     public void setPassive(XSBooleanValue newIsPassive);
123 
124 }