1 /* LDAPCertStoreParameters.java -- LDAP CertStore parameters. 2 Copyright (C) 2003 Free Software Foundation, Inc. 3 4 This file is part of GNU Classpath. 5 6 GNU Classpath is free software; you can redistribute it and/or modify 7 it under the terms of the GNU General Public License as published by 8 the Free Software Foundation; either version 2, or (at your option) 9 any later version. 10 11 GNU Classpath is distributed in the hope that it will be useful, but 12 WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 General Public License for more details. 15 16 You should have received a copy of the GNU General Public License 17 along with GNU Classpath; see the file COPYING. If not, write to the 18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19 02110-1301 USA. 20 21 Linking this library statically or dynamically with other modules is 22 making a combined work based on this library. Thus, the terms and 23 conditions of the GNU General Public License cover the whole 24 combination. 25 26 As a special exception, the copyright holders of this library give you 27 permission to link this library with independent modules to produce an 28 executable, regardless of the license terms of these independent 29 modules, and to copy and distribute the resulting executable under 30 terms of your choice, provided that you also meet, for each linked 31 independent module, the terms and conditions of the license of that 32 module. An independent module is a module which is not derived from 33 or based on this library. If you modify this library, you may extend 34 this exception to your version of the library, but you are not 35 obligated to do so. If you do not wish to do so, delete this 36 exception statement from your version. */ 37 38 39 package java.security.cert; 40 41 /** 42 * Parameters for CertStores that are retrieved via the <i>lightweight 43 * directory access protocol</i> (<b>LDAP</b>). 44 * 45 * @see CertStore 46 */ 47 public class LDAPCertStoreParameters implements CertStoreParameters 48 { 49 50 // Constants and fields. 51 // ------------------------------------------------------------------------ 52 53 /** The default LDAP port. */ 54 private static final int LDAP_PORT = 389; 55 56 /** The server name. */ 57 private final String serverName; 58 59 /** The LDAP port. */ 60 private final int port; 61 62 // Constructors. 63 // ------------------------------------------------------------------------ 64 65 /** 66 * Create a new LDAPCertStoreParameters object, with a servername of 67 * "localhost" and a port of 389. 68 */ LDAPCertStoreParameters()69 public LDAPCertStoreParameters() 70 { 71 this("localhost", LDAP_PORT); 72 } 73 74 /** 75 * Create a new LDAPCertStoreParameters object, with a specified 76 * server name and a port of 389. 77 * 78 * @param serverName The LDAP server name. 79 * @throws NullPointerException If <i>serverName</i> is null. 80 */ LDAPCertStoreParameters(String serverName)81 public LDAPCertStoreParameters(String serverName) 82 { 83 this(serverName, LDAP_PORT); 84 } 85 86 /** 87 * Create a new LDAPCertStoreParameters object, with a specified 88 * server name and port. 89 * 90 * @param serverName The LDAP server name. 91 * @param port The LDAP port. 92 * @throws NullPointerException If <i>serverName</i> is null. 93 */ LDAPCertStoreParameters(String serverName, int port)94 public LDAPCertStoreParameters(String serverName, int port) 95 { 96 if (serverName == null) 97 throw new NullPointerException(); 98 this.serverName = serverName; 99 this.port = port; 100 } 101 102 // Instance methods. 103 // ------------------------------------------------------------------------ 104 clone()105 public Object clone() 106 { 107 return new LDAPCertStoreParameters(serverName, port); 108 } 109 110 /** 111 * Return the server name. 112 * 113 * @return The server name. 114 */ getServerName()115 public String getServerName() 116 { 117 return serverName; 118 } 119 120 /** 121 * Return the port. 122 * 123 * @return the port. 124 */ getPort()125 public int getPort() 126 { 127 return port; 128 } 129 130 /** 131 * Return a string representation of these parameters. 132 * 133 * @return The string representation of these parameters. 134 */ toString()135 public String toString() 136 { 137 return "LDAPCertStoreParameters: [ serverName: " + serverName 138 + "; port: " + port + " ]"; 139 } 140 } 141