001 /*
002 * Copyright 2000-2001 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package java.security.cert;
027
028 /**
029 * Parameters used as input for the LDAP <code>CertStore</code> algorithm.
030 * <p>
031 * This class is used to provide necessary configuration parameters (server
032 * name and port number) to implementations of the LDAP <code>CertStore</code>
033 * algorithm.
034 * <p>
035 * <b>Concurrent Access</b>
036 * <p>
037 * Unless otherwise specified, the methods defined in this class are not
038 * thread-safe. Multiple threads that need to access a single
039 * object concurrently should synchronize amongst themselves and
040 * provide the necessary locking. Multiple threads each manipulating
041 * separate objects need not synchronize.
042 *
043 * @version 1.15 05/05/07
044 * @since 1.4
045 * @author Steve Hanna
046 * @see CertStore
047 */
048 public class LDAPCertStoreParameters implements CertStoreParameters {
049
050 private static final int LDAP_DEFAULT_PORT = 389;
051
052 /**
053 * the port number of the LDAP server
054 */
055 private int port;
056
057 /**
058 * the DNS name of the LDAP server
059 */
060 private String serverName;
061
062 /**
063 * Creates an instance of <code>LDAPCertStoreParameters</code> with the
064 * specified parameter values.
065 *
066 * @param serverName the DNS name of the LDAP server
067 * @param port the port number of the LDAP server
068 * @exception NullPointerException if <code>serverName</code> is
069 * <code>null</code>
070 */
071 public LDAPCertStoreParameters(String serverName, int port) {
072 if (serverName == null)
073 throw new NullPointerException();
074 this .serverName = serverName;
075 this .port = port;
076 }
077
078 /**
079 * Creates an instance of <code>LDAPCertStoreParameters</code> with the
080 * specified server name and a default port of 389.
081 *
082 * @param serverName the DNS name of the LDAP server
083 * @exception NullPointerException if <code>serverName</code> is
084 * <code>null</code>
085 */
086 public LDAPCertStoreParameters(String serverName) {
087 this (serverName, LDAP_DEFAULT_PORT);
088 }
089
090 /**
091 * Creates an instance of <code>LDAPCertStoreParameters</code> with the
092 * default parameter values (server name "localhost", port 389).
093 */
094 public LDAPCertStoreParameters() {
095 this ("localhost", LDAP_DEFAULT_PORT);
096 }
097
098 /**
099 * Returns the DNS name of the LDAP server.
100 *
101 * @return the name (not <code>null</code>)
102 */
103 public String getServerName() {
104 return serverName;
105 }
106
107 /**
108 * Returns the port number of the LDAP server.
109 *
110 * @return the port number
111 */
112 public int getPort() {
113 return port;
114 }
115
116 /**
117 * Returns a copy of this object. Changes to the copy will not affect
118 * the original and vice versa.
119 * <p>
120 * Note: this method currently performs a shallow copy of the object
121 * (simply calls <code>Object.clone()</code>). This may be changed in a
122 * future revision to perform a deep copy if new parameters are added
123 * that should not be shared.
124 *
125 * @return the copy
126 */
127 public Object clone() {
128 try {
129 return super .clone();
130 } catch (CloneNotSupportedException e) {
131 /* Cannot happen */
132 throw new InternalError(e.toString());
133 }
134 }
135
136 /**
137 * Returns a formatted string describing the parameters.
138 *
139 * @return a formatted string describing the parameters
140 */
141 public String toString() {
142 StringBuffer sb = new StringBuffer();
143 sb.append("LDAPCertStoreParameters: [\n");
144
145 sb.append(" serverName: " + serverName + "\n");
146 sb.append(" port: " + port + "\n");
147 sb.append("]");
148 return sb.toString();
149 }
150 }
|