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.xacml.XACMLObject;
24  
25  /** XACML ResourceMatch schema type. */
26  public interface ResourceMatchType extends XACMLObject {
27      
28      /** Local name of the element ResourceMatch. */
29      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "ResourceMatch";
30  
31      /** QName of the element ResourceMatch. */
32      public static final QName DEFAULT_ELEMENT_NAME = new QName(XACMLConstants.XACML20_NS,
33              DEFAULT_ELEMENT_LOCAL_NAME, XACMLConstants.XACML_PREFIX);
34  
35      /** Local name of the XSI type. */
36      public static final String SCHEMA_TYPE_LOCAL_NAME = "ResourceMatchType";
37  
38      /** QName of the XSI type. */
39      public static final QName SCHEMA_TYPE_NAME = new QName(XACMLConstants.XACML20_NS, SCHEMA_TYPE_LOCAL_NAME,
40              XACMLConstants.XACML_PREFIX);
41      
42      /** MatchID attribute name. */
43      public static final String MATCH_ID_ATTRIB_NAME = "MatchId";
44  
45      /**
46       * Gets the attribute value for this match.
47       * 
48       * @return attribute value for this match
49       */
50      public AttributeValueType getAttributeValue();
51  
52      /**
53       * Sets the attribute value for this match.
54       * 
55       * @param value attribute value for this match
56       */
57      public void setAttributeValue(AttributeValueType value);
58  
59      /**
60       * Gets the resource attribute designator for this match.
61       * 
62       * @return resource attribute designator for this match
63       */
64      public AttributeDesignatorType getResourceAttributeDesignator();
65  
66      /**
67       * Sets the resource attribute designator for this match.
68       * 
69       * @param attribute resource attribute designator for this match
70       */
71      public void setResourceAttributeDesignator(AttributeDesignatorType attribute);
72  
73      /**
74       * Gets the attribute selector for this match.
75       * 
76       * @return attribute selector for this match
77       */
78      public AttributeSelectorType getAttributeSelector();
79  
80      /**
81       * Sets the attribute selector for this match.
82       * 
83       * @param selector attribute selector for this match
84       */
85      public void setAttributeSelector(AttributeSelectorType selector);
86      
87      /**
88       * Gets the ID of this match.
89       * 
90       * @return ID of this match
91       */
92      public String getMatchId();
93      
94      /**
95       * Sets the ID of this match.
96       * 
97       * @param id ID of this match
98       */
99      public void setMatchId(String id);
100 }