View Javadoc

1   /*
2    * Copyright [2005] [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.saml1.core;
18  
19  import java.util.List;
20  
21  import javax.xml.namespace.QName;
22  
23  import org.opensaml.common.xml.SAMLConstants;
24  
25  /**
26   * This interface defines how the SAML1 <code> Request </code> objects behave.
27   */
28  public interface Request extends RequestAbstractType {
29  
30      /** Element name, no namespace. */
31      public final static String DEFAULT_ELEMENT_LOCAL_NAME = "Request";
32      
33      /** Default element name */
34      public final static QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML10P_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML1P_PREFIX);
35      
36      /** Local name of the XSI type */
37      public final static String TYPE_LOCAL_NAME = "RequestType"; 
38          
39      /** QName of the XSI type */
40      public final static QName TYPE_NAME = new QName(SAMLConstants.SAML10P_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML1P_PREFIX);
41  
42      /* 
43       * A bit odd this, it s a choice so only one of these will return any value
44       */
45      
46      /** Get the request Query, SubjectQuery, AuthenticationQuery, AttributeQuery, or AuthorizationDecisionQuery */ 
47      public Query getQuery();
48      
49      /** Get the request SubjectQuery, AuthenticationQuery, AttributeQuery, or AuthorizationDecisionQuery */ 
50      public SubjectQuery getSubjectQuery();
51      
52      /** Get the query AuthenticationQuery */ 
53      public AuthenticationQuery getAuthenticationQuery();
54      
55      /** Get the request AttributeQuery */ 
56      public AttributeQuery getAttributeQuery();
57      
58      /** Get the request AuthorizationDecisionQuery */ 
59      public AuthorizationDecisionQuery getAuthorizationDecisionQuery();
60      
61      /** Set the query (Query, SubjectQuery, AuthenticationQuery, AttributeQuery, AuthorizationDecisioonQuery 
62       */ 
63      public void setQuery(Query query) throws IllegalArgumentException;
64      
65      /** Get the lists of AssertionIDReferences */
66      public List <AssertionIDReference> getAssertionIDReferences();
67      
68      /** Get the lists of */
69      public List <AssertionArtifact> getAssertionArtifacts();
70  }