View Javadoc

1   /*
2    * Copyright 2008 Members of the EGEE Collaboration.
3    * Copyright 2008 University Corporation for Advanced Internet Development, Inc.
4    *
5    * Licensed under the Apache License, Version 2.0 (the "License");
6    * you may not use this file except in compliance with the License.
7    * You may obtain a copy of the License at
8    *
9    * http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.opensaml.xacml.policy;
19  
20  import javax.xml.namespace.QName;
21  
22  import org.opensaml.xacml.XACMLConstants;
23  import org.opensaml.xml.schema.XSBooleanValue;
24  
25  /** XACML AttribtueDesignator schema type. */
26  public interface AttributeDesignatorType extends ExpressionType {
27  
28      /** Local name of the element SubjectAttributeDesignator. */
29      public static final String SUBJECT_ATTRIBUTE_DESIGNATOR_ELEMENT_LOCAL_NAME = "SubjectAttributeDesignator";
30  
31      /** QName of the element SubjectAttributeDesignator. */
32      public static final QName SUBJECT_ATTRIBUTE_DESIGNATOR_ELEMENT_NAME = new QName(
33  	    XACMLConstants.XACML20_NS,
34  	    SUBJECT_ATTRIBUTE_DESIGNATOR_ELEMENT_LOCAL_NAME,
35  	    XACMLConstants.XACML_PREFIX);
36  
37      /** Local name of the element ResourceAttributeDesignator. */
38      public static final String RESOURCE_ATTRIBUTE_DESIGNATOR_ELEMENT_LOCAL_NAME = "ResourceAttributeDesignator";
39  
40      /** QName of the element ResourceAttributeDesignator. */
41      public static final QName RESOURCE_ATTRIBUTE_DESIGNATOR_ELEMENT_NAME = new QName(
42  	    XACMLConstants.XACML20_NS,
43  	    RESOURCE_ATTRIBUTE_DESIGNATOR_ELEMENT_LOCAL_NAME,
44  	    XACMLConstants.XACML_PREFIX);
45  
46      /** Local name of the element ActionAttributeDesignator. */
47      public static final String ACTION_ATTRIBUTE_DESIGNATOR_ELEMENT_LOCAL_NAME = "ActionAttributeDesignator";
48  
49      /** QName of the element ActionAttributeDesignator. */
50      public static final QName ACTION_ATTRIBUTE_DESIGNATOR_ELEMENT_NAME = new QName(
51  	    XACMLConstants.XACML20_NS,
52  	    ACTION_ATTRIBUTE_DESIGNATOR_ELEMENT_LOCAL_NAME,
53  	    XACMLConstants.XACML_PREFIX);
54  
55      /** Local name of the element EnvironmentAttribtueDesignator. */
56      public static final String ENVIRONMENT_ATTRIBUTE_DESIGNATOR_ELEMENT_LOCAL_NAME = "EnvironmentAttribtueDesignator";
57  
58      /** QName of the element EnvironmentAttribtueDesignator. */
59      public static final QName ENVIRONMENT_ATTRIBUTE_DESIGNATOR_ELEMENT_NAME = new QName(
60  	    XACMLConstants.XACML20_NS,
61  	    ENVIRONMENT_ATTRIBUTE_DESIGNATOR_ELEMENT_LOCAL_NAME,
62  	    XACMLConstants.XACML_PREFIX);
63  
64      /** Local name of the XSI type. */
65      public static final String SCHEMA_TYPE_LOCAL_NAME = "AttributeDesignatorType";
66  
67      /** QName of the XSI type. */
68      public static final QName SCHEMA_TYPE_NAME = new QName(
69  	    XACMLConstants.XACML20_NS, SCHEMA_TYPE_LOCAL_NAME,
70  	    XACMLConstants.XACML_PREFIX);
71  
72      /** AttribtueId attribute name. */
73      public static final String ATTRIBUTE_ID_ATTRIB_NAME = "AttributeId";
74  
75      /** DataType attribute name. */
76      public static final String DATA_TYPE_ATTRIB_NAME = "DataType";
77  
78      /** Issuer attribute name. */
79      public static final String ISSUER_ATTRIB_NAME = "Issuer";
80  
81      /** MustBePresent attribute name. */
82      public static final String MUST_BE_PRESENT_ATTRIB_NAME = "MustBePresent";
83  
84      /**
85       * Gets the ID of the designated attribute.
86       * 
87       * @return ID of the designated attribute
88       */
89      public String getAttributeId();
90  
91      /**
92       * Sets the ID of the designated attribute.
93       * 
94       * @param id
95       *                ID of the designated attribute
96       */
97      public void setAttribtueId(String id);
98  
99      /**
100      * Gets the data type of the designated attribute.
101      * 
102      * @return data type of the designated attribute
103      */
104     public String getDataType();
105 
106     /**
107      * Sets the data type of the designated attribute.
108      * 
109      * @param type
110      *                data type of the designated attribute
111      */
112     public void setDataType(String type);
113 
114     /**
115      * Gets the issuer of the designated attribute.
116      * 
117      * @return issuer of the designated attribute
118      */
119     public String getIssuer();
120 
121     /**
122      * Sets the issuer of the designated attribute.
123      * 
124      * @param issuer
125      *                issuer of the designated attribute
126      */
127     public void setIssuer(String issuer);
128 
129     /**
130      * Gets whether the designated attribute must be present.
131      * 
132      * @return whether the designated attribute must be present
133      */
134     public XSBooleanValue getMustBePresentXSBoolean();
135 
136     /**
137      * Sets whether the designated attribute must be present.
138      * 
139      * @param present
140      *                whether the designated attribute must be present
141      */
142     public void setMustBePresentXSBoolean(XSBooleanValue present);
143 
144     /**
145      * Sets whether the designated attribute must be present.
146      * 
147      * @param present
148      *                whether the designated attribute must be present
149      */
150     public void setMustBePresent(Boolean present);
151 
152     /**
153      * Gets whether the designated attribute must be present.
154      * 
155      * @return whether the designated attribute must be present
156      */
157     public Boolean getMustBePresent();
158 }