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.ws.wssecurity;
19  
20  import javax.xml.namespace.QName;
21  
22  import org.opensaml.xml.AttributeExtensibleXMLObject;
23  
24  /**
25   * The <wsse:Reference> empty element.
26   * 
27   * @see "WS-Security 2004, Chapter 7.2"
28   * 
29   */
30  public interface Reference extends AttributeExtensibleXMLObject, WSSecurityObject {
31  
32      /** Element local name. */
33      public static final String ELEMENT_LOCAL_NAME = "Reference";
34  
35      /** Qualified element name. */
36      public static final QName ELEMENT_NAME =
37          new QName(WSSecurityConstants.WSSE_NS, ELEMENT_LOCAL_NAME, WSSecurityConstants.WSSE_PREFIX);
38      
39      /** Local name of the XSI type. */
40      public static final String TYPE_LOCAL_NAME = "ReferenceType"; 
41          
42      /** QName of the XSI type. */
43      public static final QName TYPE_NAME = 
44          new QName(WSSecurityConstants.WSSE_NS, TYPE_LOCAL_NAME, WSSecurityConstants.WSSE_PREFIX);
45  
46      /** The wsse:Reference/@URI attribute local name. */
47      public static final String URI_ATTRIB_NAME= "URI";
48      
49      /** The wsse:Reference/@ValueType attribute local name. */
50      public static final String VALUE_TYPE_ATTRIB_NAME= "ValueType";
51  
52      /**
53       * Returns the wsse:Reference/@URI attribute value.
54       * 
55       * @return the URI attribute value.
56       */
57      public String getURI();
58  
59      /**
60       * Sets the wsse:Reference/@URI attribute value.
61       * 
62       * @param newURI the URI to set.
63       */
64      public void setURI(String newURI);
65      
66      /**
67       * Returns the ValueType attribute URI value.
68       * 
69       * @return the ValueType attribute value or <code>null</code>.
70       */
71      public String getValueType();
72  
73      /**
74       * Sets the ValueType attribute URI value.
75       * 
76       * @param newValueType the ValueType attribute value.
77       */
78      public void setValueType(String newValueType);
79      
80  }