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.wspolicy;
19  
20  import javax.xml.namespace.QName;
21  
22  import org.opensaml.xml.AttributeExtensibleXMLObject;
23  
24  /**
25   * The wsp:PolicyReference element.
26   * 
27   * @see "WS-Policy (http://schemas.xmlsoap.org/ws/2004/09/policy)"
28   * 
29   */
30  public interface PolicyReference extends AttributeExtensibleXMLObject, WSPolicyObject {
31  
32      /** Element local name. */
33      public static final String ELEMENT_LOCAL_NAME = "PolicyReference";
34  
35      /** Default element name. */
36      public static final QName ELEMENT_NAME =
37          new QName(WSPolicyConstants.WSP_NS, ELEMENT_LOCAL_NAME, WSPolicyConstants.WSP_PREFIX);
38  
39      /** The wsp:PolicyReference/@URI attribute local name. */
40      public static final String URI_ATTRIB_NAME = "URI";
41  
42      /** The wsp:PolicyReference/@Digest attribute local name. */
43      public static final String DIGEST_ATTRIB_NAME = "Digest";
44  
45      /** The wsp:PolicyReference/@Digest attribute local name. */
46      public static final String DIGEST_ALGORITHM_ATTRIB_NAME = "DigestAlgorithm";
47  
48      /** The default wsp:PolicyReference/@DigestAlgorithm attribute value. */
49      public static final String DIGEST_ALGORITHM_SHA1EXC = WSPolicyConstants.WSP_NS + "/Sha1Exc";
50  
51      /**
52       * Returns the wsp:PolicyReference/@URI attribute value.
53       * 
54       * @return the URI attribute value.
55       */
56      public String getURI();
57  
58      /**
59       * Sets the wsp:PolicyReference/@URI attribute value.
60       * 
61       * @param uri the URI attribute value to set.
62       */
63      public void setURI(String uri);
64  
65      /**
66       * Returns the wsp:PolicyReference/@Digest attribute URI value.
67       * 
68       * @return the Digest attribute URI value.
69       */
70      public String getDigest();
71  
72      /**
73       * Sets the wsp:PolicyReference/@Digest attribute URI value.
74       * 
75       * @param digest the Digest attribute URI value to set.
76       */
77      public void setDigest(String digest);
78  
79      /**
80       * Returns the wsp:PolicyReference/@DigestAlgoritm attribute Base64 binary value.
81       * 
82       * @return the DigestAlgoritm attribute Base64 binary value.
83       */
84      public String getDigestAlgorithm();
85  
86      /**
87       * Sets the wsp:PolicyReference/@DigestAlgoritm attribute Base64 binary value.
88       * 
89       * @param digestAlgorithm the DigestAlgoritm attribute Base64 binary value to set.
90       */
91      public void setDigestAlgorithm(String digestAlgorithm);
92  
93  }