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.profile.saml;
20  
21  import java.util.List;
22  
23  import javax.xml.namespace.QName;
24  
25  import org.opensaml.saml2.core.RequestAbstractType;
26  import org.opensaml.xacml.XACMLObject;
27  import org.opensaml.xacml.ctx.RequestType;
28  import org.opensaml.xacml.policy.IdReferenceType;
29  
30  /** A SAML XACML profile XACMLPolicyQuery schema type. */
31  public interface XACMLPolicyQueryType extends RequestAbstractType, XACMLObject {
32  
33      /** Element local name. */
34      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "XACMLPolicyQuery";
35  
36      /** Default element name for XACML 1.0. */
37      public static final QName DEFAULT_ELEMENT_NAME_XACML10 = new QName(SAMLProfileConstants.SAML20XACML10P_NS,
38              DEFAULT_ELEMENT_LOCAL_NAME, SAMLProfileConstants.SAML20XACMLPROTOCOL_PREFIX);
39  
40      /** Default element name for XACML 1.1. */
41      public static final QName DEFAULT_ELEMENT_NAME_XACML11 = new QName(SAMLProfileConstants.SAML20XACML1_1P_NS,
42              DEFAULT_ELEMENT_LOCAL_NAME, SAMLProfileConstants.SAML20XACMLPROTOCOL_PREFIX);
43  
44      /** Default element name for XACML 2.0. */
45      public static final QName DEFAULT_ELEMENT_NAME_XACML20 = new QName(SAMLProfileConstants.SAML20XACML20P_NS,
46              DEFAULT_ELEMENT_LOCAL_NAME, SAMLProfileConstants.SAML20XACMLPROTOCOL_PREFIX);
47  
48      /** Default element nam for XACML 3.0. */
49      public static final QName DEFAULT_ELEMENT_NAME_XACML30 = new QName(SAMLProfileConstants.SAML20XACML30P_NS,
50              DEFAULT_ELEMENT_LOCAL_NAME, SAMLProfileConstants.SAML20XACMLPROTOCOL_PREFIX);
51  
52      /** Local name of the XSI type. */
53      public static final String TYPE_LOCAL_NAME = "XACMLPolicyQueryType";
54  
55      /** QName of the XSI type.XACML1.0. */
56      public static final QName TYPE_NAME_XACML10 = new QName(SAMLProfileConstants.SAML20XACML10P_NS, TYPE_LOCAL_NAME,
57              SAMLProfileConstants.SAML20XACMLPROTOCOL_PREFIX);
58  
59      /** QName of the XSI type.XACML1.1. */
60      public static final QName TYPE_NAME_XACML11 = new QName(SAMLProfileConstants.SAML20XACML1_1P_NS, TYPE_LOCAL_NAME,
61              SAMLProfileConstants.SAML20XACMLPROTOCOL_PREFIX);
62  
63      /** QName of the XSI type.XACML2.0. */
64      public static final QName TYPE_NAME_XACML20 = new QName(SAMLProfileConstants.SAML20XACML20P_NS, TYPE_LOCAL_NAME,
65              SAMLProfileConstants.SAML20XACMLPROTOCOL_PREFIX);
66  
67      /** QName of the XSI type.XACML3.0. */
68      public static final QName TYPE_NAME_XACML30 = new QName(SAMLProfileConstants.SAML20XACML30P_NS, TYPE_LOCAL_NAME,
69              SAMLProfileConstants.SAML20XACMLPROTOCOL_PREFIX);
70  
71      /**
72       * Gets the Requests inside the policy query.
73       * 
74       * @return the XACML Request
75       */
76      public List<RequestType> getRequests();
77  
78      /**
79       * Gets the IDs for referenced policy sets.
80       * 
81       * @return IDs for referenced policy sets
82       */
83      public List<IdReferenceType> getPolicySetIdReferences();
84  
85      /**
86       * Gets the IDs for referenced policies.
87       * 
88       * @return IDs for referenced policies
89       */
90      public List<IdReferenceType> getPolicyIdReferences();
91  }