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  /**
18   * 
19   */
20  
21  package org.opensaml.saml2.core;
22  
23  import javax.xml.namespace.QName;
24  
25  import org.opensaml.common.SAMLObject;
26  import org.opensaml.common.xml.SAMLConstants;
27  
28  /**
29   * SAML 2.0 Core StatusCode.
30   */
31  public interface StatusCode extends SAMLObject {
32  
33      /** Local Name of StatusCode. */
34      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "StatusCode";
35  
36      /** Default element name. */
37      public static final QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20P_NS, DEFAULT_ELEMENT_LOCAL_NAME,
38              SAMLConstants.SAML20P_PREFIX);
39  
40      /** Local name of the XSI type. */
41      public static final String TYPE_LOCAL_NAME = "StatusCodeType";
42  
43      /** QName of the XSI type. */
44      public static final QName TYPE_NAME = new QName(SAMLConstants.SAML20P_NS, TYPE_LOCAL_NAME,
45              SAMLConstants.SAML20P_PREFIX);
46  
47      /** Local Name of the Value attribute. */
48      public static final String VALUE_ATTRIB_NAME = "Value";
49  
50      /** URI for Success status code. */
51      public static final String SUCCESS_URI = "urn:oasis:names:tc:SAML:2.0:status:Success";
52  
53      /** URI for Requester status code. */
54      public static final String REQUESTER_URI = "urn:oasis:names:tc:SAML:2.0:status:Requester";
55  
56      /** URI for Responder status code. */
57      public static final String RESPONDER_URI = "urn:oasis:names:tc:SAML:2.0:status:Responder";
58  
59      /** URI for VersionMismatch status code. */
60      public static final String VERSION_MISMATCH_URI = "urn:oasis:names:tc:SAML:2.0:status:VersionMismatch";
61  
62      /** URI for AuthnFailed status code. */
63      public static final String AUTHN_FAILED_URI = "urn:oasis:names:tc:SAML:2.0:status:AuthnFailed";
64  
65      /** URI for InvalidAttrNameOrValue status code. */
66      public static final String INVALID_ATTR_NAME_VALUE_URI = "urn:oasis:names:tc:SAML:2.0:status:InvalidAttrNameOrValue";
67  
68      /** URI for InvalidNameIDPolicy status code. */
69      public static final String INVALID_NAMEID_POLICY_URI = "urn:oasis:names:tc:SAML:2.0:status:InvalidNameIDPolicy";
70  
71      /** URI for NoAuthnContext status code. */
72      public static final String NO_AUTHN_CONTEXT_URI = "urn:oasis:names:tc:SAML:2.0:status:NoAuthnContext";
73  
74      /** URI for NoAvailableIDP status code. */
75      public static final String NO_AVAILABLE_IDP_URI = "urn:oasis:names:tc:SAML:2.0:status:NoAvailableIDP";
76  
77      /** URI for NoPassive status code. */
78      public static final String NO_PASSIVE_URI = "urn:oasis:names:tc:SAML:2.0:status:NoPassive";
79  
80      /** URI for NoSupportedIDP status code. */
81      public static final String NO_SUPPORTED_IDP_URI = "urn:oasis:names:tc:SAML:2.0:status:NoSupportedIDP";
82  
83      /** URI for PartialLogout status code. */
84      public static final String PARTIAL_LOGOUT_URI = "urn:oasis:names:tc:SAML:2.0:status:PartialLogout";
85  
86      /** URI for ProxyCountExceeded status code. */
87      public static final String PROXY_COUNT_EXCEEDED_URI = "urn:oasis:names:tc:SAML:2.0:status:ProxyCountExceeded";
88  
89      /** URI for RequestDenied status code. */
90      public static final String REQUEST_DENIED_URI = "urn:oasis:names:tc:SAML:2.0:status:RequestDenied";
91  
92      /** URI for RequestUnsupported status code. */
93      public static final String REQUEST_UNSUPPORTED_URI = "urn:oasis:names:tc:SAML:2.0:status:RequestUnsupported";
94  
95      /** URI for RequestVersionDeprecated status code. */
96      public static final String REQUEST_VERSION_DEPRECATED_URI = "urn:oasis:names:tc:SAML:2.0:status:RequestVersionDeprecated";
97  
98      /** URI for RequestVersionTooHigh status code. */
99      public static final String REQUEST_VERSION_TOO_HIGH_URI = "urn:oasis:names:tc:SAML:2.0:status:RequestVersionTooHigh";
100     
101     /** URI for RequestVersionTooLow status code. */
102     public static final String REQUEST_VERSION_TOO_LOW_URI = "urn:oasis:names:tc:SAML:2.0:status:RequestVersionTooLow";
103 
104     /** URI for ResourceNotRecognized status code. */
105     public static final String RESOURCE_NOT_RECOGNIZED_URI = "urn:oasis:names:tc:SAML:2.0:status:ResourceNotRecognized";
106 
107     /** URI for TooManyResponses status code. */
108     public static final String TOO_MANY_RESPONSES = "urn:oasis:names:tc:SAML:2.0:status:TooManyResponses";
109 
110     /** URI for UnknownAttrProfile status code. */
111     public static final String UNKNOWN_ATTR_PROFILE_URI = "urn:oasis:names:tc:SAML:2.0:status:UnknownAttrProfile";
112 
113     /** URI for UnknownPrincipal status code. */
114     public static final String UNKNOWN_PRINCIPAL_URI = "urn:oasis:names:tc:SAML:2.0:status:UnknownPrincipal";
115 
116     /** URI for UnsupportedBinding status code. */
117     public static final String UNSUPPORTED_BINDING_URI = "urn:oasis:names:tc:SAML:2.0:status:UnsupportedBinding";
118 
119     /**
120      * Gets the Status Code of this Status Code.
121      * 
122      * @return StatusCode StatusCode
123      */
124     public StatusCode getStatusCode();
125 
126     /**
127      * Sets the Status Code of this Status Code.
128      * 
129      * @param newStatusCode the Status Code of this Status Code.
130      */
131     public void setStatusCode(StatusCode newStatusCode);
132 
133     /**
134      * Gets the Value of this Status Code.
135      * 
136      * @return StatusCode Value
137      */
138     public String getValue();
139 
140     /**
141      * Sets the Value of this Status Code.
142      * 
143      * @param newValue the Value of this Status Code
144      */
145     public void setValue(String newValue);
146 }