View Javadoc

1   /*
2    * Copyright [2005] [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  /**
18   * 
19   */
20  
21  package org.opensaml.saml1.core;
22  
23  import javax.xml.namespace.QName;
24  
25  import org.opensaml.common.SAMLObject;
26  import org.opensaml.common.xml.SAMLConstants;
27  
28  /**
29   * Interface to define how a SubjectLocality element behaves.
30   */
31  public interface SubjectLocality extends SAMLObject {
32  
33      /** Element name, no namespace. */
34      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "SubjectLocality";
35  
36      /** Default element name. */
37      public static final QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML1_NS, DEFAULT_ELEMENT_LOCAL_NAME,
38              SAMLConstants.SAML1_PREFIX);
39  
40      /** Local name of the XSI type. */
41      public static final String TYPE_LOCAL_NAME = "SubjectLocalityType";
42  
43      /** QName of the XSI type. */
44      public static final QName TYPE_NAME = new QName(SAMLConstants.SAML1_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML1_PREFIX);
45  
46      /** Name for the IPAddress attribute. */
47      public static final String IPADDRESS_ATTRIB_NAME = "IPAddress";
48  
49      /** Name for the DNSAddress attribute. */
50      public static final String DNSADDRESS_ATTRIB_NAME = "DNSAddress";
51  
52      /**
53       * Gets the IP address of the locality.
54       * 
55       * @return IP address of the locality
56       */
57      public String getIPAddress();
58  
59      /**
60       * Sets the IP address of the locality.
61       * 
62       * @param address IP address of the locality
63       */
64      public void setIPAddress(String address);
65  
66      /**
67       * Gets the DNS name of the locality.
68       * 
69       * @return DNS name of the locality
70       */
71      public String getDNSAddress();
72  
73      /**
74       * Sets the DNS name of the locality.
75       * 
76       * @param address DNS name of the locality
77       */
78      public void setDNSAddress(String address);
79  }