View Javadoc

1   /*
2    * Copyright 2008 University Corporation for Advanced Internet Development, Inc.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.opensaml.ws.wsfed;
18  
19  import javax.xml.namespace.QName;
20  
21  /**
22   * This interface defines how the object representing a WS End Point Reference <code> EndPointReference </code> element
23   * behaves.
24   */
25  public interface EndPointReference extends WSFedObject {
26  
27      /** Element name, no namespace. */
28      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "EndPointReference";
29  
30      /** Default element name. */
31      public static final QName DEFAULT_ELEMENT_NAME = new QName(WSFedConstants.WSADDRESS_NS, DEFAULT_ELEMENT_LOCAL_NAME,
32              WSFedConstants.WSADDRESS_PREFIX);
33  
34      /** Local name of the XSI type. */
35      public static final String TYPE_LOCAL_NAME = "EndPointReferenceType";
36  
37      /** QName of the XSI type. */
38      public static final QName TYPE_NAME = new QName(WSFedConstants.WSADDRESS_NS, TYPE_LOCAL_NAME,
39              WSFedConstants.WSADDRESS_PREFIX);
40  
41      /**
42       * Return the object representing the <code>Address</code> (element).
43       * 
44       * @return the end point address
45       */
46      public Address getAddress();
47  
48      /**
49       * Sets the end point address as an object.
50       * 
51       * @param address the end point address
52       */
53      public void setAddress(Address address);
54  }