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  /**
23   * Interface for element having a <code>@wsse11:TokenType</code>; attribute.
24   * 
25   * @see "WS-Security 2004, Chapter 7.1 SecurityTokenReference Element."
26   * 
27   */
28  public interface TokenTypeBearing {
29  
30      /**
31       * The <code>@wsse11:TokenType</code> attribute local name.
32       */
33      public static final String WSSE11_TOKEN_TYPE_ATTR_LOCAL_NAME = "TokenType";
34  
35      /**
36       * The <code>@wsse11:TokenType</code> qualified attribute name.
37       */
38      public static final QName WSSE11_TOKEN_TYPE_ATTR_NAME =
39          new QName(WSSecurityConstants.WSSE11_NS, WSSE11_TOKEN_TYPE_ATTR_LOCAL_NAME, WSSecurityConstants.WSSE11_PREFIX);
40  
41      /**
42       * Returns the <code>@wsse11:TokenType</code> attribute value.
43       * 
44       * @return the <code>@wsse11:TokenType</code> attribute value or <code>null</code>.
45       */
46      public String getWSSE11TokenType();
47  
48      /**
49       * Sets the <code>@wsse11:TokenType</code> attribute value.
50       * 
51       * @param tokenType the <code>@wsse11:TokenType</code> attribute value to set.
52       */
53      public void setWSSE11TokenType(String tokenType);
54  
55  }