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.wsaddressing;
19  
20  import javax.xml.namespace.QName;
21  
22  import org.opensaml.xml.AttributeExtensibleXMLObject;
23  import org.opensaml.xml.ElementExtensibleXMLObject;
24  
25  /**
26   * Interface for element of type {@link EndpointReferenceType}.
27   * 
28   * @see "WS-Addressing 1.0 - Core"
29   * 
30   */
31  public interface EndpointReferenceType extends AttributeExtensibleXMLObject, ElementExtensibleXMLObject, WSAddressingObject {
32      
33      /** Local name of the XSI type. */
34      public static final String TYPE_LOCAL_NAME = "EndpointReferenceType"; 
35          
36      /** QName of the XSI type. */
37      public static final QName TYPE_NAME = 
38          new QName(WSAddressingConstants.WSA_NS, TYPE_LOCAL_NAME, WSAddressingConstants.WSA_PREFIX);
39  
40      /**
41       * Returns the <wsa:Address> child element.
42       * 
43       * @return the {@link Address} child element or <code>null</code>
44       */
45      public Address getAddress();
46  
47      /**
48       * Sets the &lt;wsa:Address&gt; child element.
49       * 
50       * @param address the {@link Address} child element to set.
51       */
52      public void setAddress(Address address);
53  
54      /**
55       * Returns the optional &lt;wsa:Metadata&gt; child element.
56       * 
57       * @return the {@link Metadata} child element or <code>null</code>.
58       */
59      public Metadata getMetadata();
60  
61      /**
62       * Sets the &lt;wsa:Metadata&gt; child element.
63       * 
64       * @param metadata the {@link Metadata} child element to set.
65       */
66      public void setMetadata(Metadata metadata);
67  
68      /**
69       * Returns the optional &lt;wsa:ReferenceParameters&gt; child element.
70       * 
71       * @return the {@link ReferenceParameters} child element or <code>null</code>.
72       */
73      public ReferenceParameters getReferenceParameters();
74  
75      /**
76       * Sets the &lt;wsa:ReferenceParameters&gt; child element.
77       * 
78       * @param referenceParameters the {@link ReferenceParameters} child element to set.
79       */
80      public void setReferenceParameters(ReferenceParameters referenceParameters);
81  
82  }