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>@wsu:Id</code> attribute.
24   * 
25   */
26  public interface IdBearing {
27  
28      /** the <code>Id</code> attribute local name. */
29      public static final String WSU_ID_ATTR_LOCAL_NAME = "Id";
30  
31      /** the <code>wsu:Id</code> qualified attribute name. */
32      public static final QName WSU_ID_ATTR_NAME =
33          new QName(WSSecurityConstants.WSU_NS, WSU_ID_ATTR_LOCAL_NAME, WSSecurityConstants.WSU_PREFIX);
34  
35      /**
36       * Returns the <code>@wsu:Id</code> attribute value.
37       * 
38       * @return The <code>@wsu:Id</code> attribute value or <code>null</code>.
39       */
40      public String getWSUId();
41  
42      /**
43       * Sets the <code>@wsu:Id</code> attribute value.
44       * 
45       * @param newId The <code>@wsu:Id</code> attribute value
46       */
47      public void setWSUId(String newId);
48  
49  }