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.saml2.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   * SAML 2.0 Core AuthzDecisionStatement.
27   */
28  public interface AuthzDecisionStatement extends Statement {
29  
30      /** Element local name. */
31      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "AuthzDecisionStatement";
32  
33      /** Default element name. */
34      public static final QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20_NS, DEFAULT_ELEMENT_LOCAL_NAME,
35              SAMLConstants.SAML20_PREFIX);
36  
37      /** Local name of the XSI type. */
38      public static final String TYPE_LOCAL_NAME = "AuthzDecisionStatementType";
39  
40      /** QName of the XSI type. */
41      public static final QName TYPE_NAME = new QName(SAMLConstants.SAML20_NS, TYPE_LOCAL_NAME,
42              SAMLConstants.SAML20_PREFIX);
43  
44      /** Resource attribute name. */
45      public static final String RESOURCE_ATTRIB_NAME = "Resource";
46  
47      /** Decision attribute name. */
48      public static final String DECISION_ATTRIB_NAME = "Decision";
49  
50      /**
51       * Get URI of the resource to which authorization is saught.
52       * 
53       * @return URI of the resource to which authorization is saught
54       */
55      public String getResource();
56  
57      /**
58       * Sets URI of the resource to which authorization is saught.
59       * 
60       * @param newResourceURI URI of the resource to which authorization is saught
61       */
62      public void setResource(String newResourceURI);
63  
64      /**
65       * Gets the decision of the authorization request.
66       * 
67       * @return the decision of the authorization request
68       */
69      public DecisionTypeEnumeration getDecision();
70  
71      /**
72       * Sets the decision of the authorization request.
73       * 
74       * @param newDecision the decision of the authorization request
75       */
76      public void setDecision(DecisionTypeEnumeration newDecision);
77  
78      /**
79       * Gets the actions authorized to be performed.
80       * 
81       * @return the actions authorized to be performed
82       */
83      public List<Action> getActions();
84  
85      /**
86       * Get the SAML assertion the authority relied on when making the authorization decision.
87       * 
88       * @return the SAML assertion the authority relied on when making the authorization decision
89       */
90      public Evidence getEvidence();
91  
92      /**
93       * Sets the SAML assertion the authority relied on when making the authorization decision.
94       * 
95       * @param newEvidence the SAML assertion the authority relied on when making the authorization decision
96       */
97      public void setEvidence(Evidence newEvidence);
98  }