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.wstrust;
19  
20  import javax.xml.namespace.QName;
21  
22  import org.opensaml.xml.schema.XSBooleanValue;
23  
24  /**
25   * The wst:Renewing element.
26   * 
27   * @see "WS-Trust 1.3, Chapter 5 Renewal Binding."
28   * 
29   */
30  public interface Renewing extends WSTrustObject {
31  
32      /** Element local name. */
33      public static final String ELEMENT_LOCAL_NAME = "Renewing";
34  
35      /** Default element name. */
36      public static final QName ELEMENT_NAME =
37          new QName(WSTrustConstants.WST_NS, ELEMENT_LOCAL_NAME, WSTrustConstants.WST_PREFIX);
38      
39      /** Local name of the XSI type. */
40      public static final String TYPE_LOCAL_NAME = "RenewingType"; 
41          
42      /** QName of the XSI type. */
43      public static final QName TYPE_NAME = 
44          new QName(WSTrustConstants.WST_NS, TYPE_LOCAL_NAME, WSTrustConstants.WST_PREFIX);
45  
46      /** The wst:Renewing/@Allow attribute local name. */
47      public static final String ALLOW_ATTRIB_NAME = "Allow";
48  
49      /** The wst:Renewing/@OK attribute local name. */
50      public static final String OK_ATTRIB_NAME = "OK";
51  
52      /**
53       * Returns the wst:Renewing/@Allow attribute value.
54       * 
55       * @return the Allow attribute value
56       */
57      public Boolean isAllow();
58      
59      /**
60       * Returns the wst:Renewing/@Allow attribute value.
61       * 
62       * @return the Allow attribute value
63       */
64      public XSBooleanValue isAllowXSBoolean();
65  
66      /**
67       * Sets the wst:Renewing/@Allow attribute value.
68       * 
69       * @param allow the Allow attribute value.
70       */
71      public void setAllow(Boolean allow);
72  
73      /**
74       * Sets the wst:Renewing/@Allow attribute value.
75       * 
76       * @param allow the Allow attribute value.
77       */
78      public void setAllow(XSBooleanValue allow);
79  
80      /**
81       * Returns the wst:Renewing/@OK attribute value.
82       * 
83       * @return the OK attribute value
84       */
85      public Boolean isOK();
86      
87      /**
88       * Returns the wst:Renewing/@OK attribute value.
89       * 
90       * @return the OK attribute value
91       */
92      public XSBooleanValue isOKXSBoolean();
93  
94      /**
95       * Sets the wst:Renewing/@OK attribute value.
96       * 
97       * @param ok the OK attribute value.
98       */
99      public void setOK(Boolean ok);
100     
101     /**
102      * Sets the wst:Renewing/@OK attribute value.
103      * 
104      * @param ok the OK attribute value.
105      */
106     public void setOK(XSBooleanValue ok);
107     
108 }