View Javadoc

1   /*
2   Copyright 2008 Members of the EGEE Collaboration.
3   Copyright 2008 University Corporation for Advanced Internet Development,
4   Inc.
5   
6   Licensed under the Apache License, Version 2.0 (the "License");
7   you may not use this file except in compliance with the License.
8   You may obtain a copy of the License at
9   
10      http://www.apache.org/licenses/LICENSE-2.0
11  
12  Unless required by applicable law or agreed to in writing, software
13  distributed under the License is distributed on an "AS IS" BASIS,
14  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  See the License for the specific language governing permissions and
16  limitations under the License.
17   */
18  
19  package org.opensaml.xacml.ctx;
20  
21  import java.util.List;
22  
23  import javax.xml.namespace.QName;
24  
25  import org.opensaml.xacml.XACMLConstants;
26  import org.opensaml.xacml.XACMLObject;
27  
28  /** XACML context Request schema type. */
29  public interface RequestType extends XACMLObject {
30  
31      /** Element local name. */
32      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "Request";
33  
34      /** Default element name. */
35      public static final QName DEFAULT_ELEMENT_NAME = new QName(XACMLConstants.XACML20CTX_NS,
36              DEFAULT_ELEMENT_LOCAL_NAME, XACMLConstants.XACMLCONTEXT_PREFIX);
37  
38      /** Local name of the XSI type. */
39      public static final String TYPE_LOCAL_NAME = "RequestType";
40  
41      /** QName of the XSI type. */
42      public static final QName TYPE_NAME = new QName(XACMLConstants.XACML20CTX_NS, TYPE_LOCAL_NAME,
43              XACMLConstants.XACMLCONTEXT_PREFIX);
44  
45      /**
46       * Gets the subjects from the request.
47       * 
48       * @return the subjects from the request
49       */
50      public List<SubjectType> getSubjects();
51  
52      /**
53       * Gets the resources from the request.
54       * 
55       * @return the resources from the request
56       */
57      public List<ResourceType> getResources();
58  
59      /**
60       * Gets the action from the request.
61       * 
62       * @return the action from the request
63       */
64      public ActionType getAction();
65  
66      /**
67       * Sets the action of the request.
68       * 
69       * @param newAction action of the request
70       */
71      public void setAction(ActionType newAction);
72  
73      /**
74       * Gets the environment from the request.
75       * 
76       * @return the environment from the request
77       */
78      public EnvironmentType getEnvironment();
79  
80      /**
81       * Sets the environment of the request.
82       * 
83       * @param environment environment of the request
84       */
85      public void setEnvironment(EnvironmentType environment);
86  }