001 /* LDAPCertStoreParameters.java -- LDAP CertStore parameters. 002 Copyright (C) 2003 Free Software Foundation, Inc. 003 004 This file is part of GNU Classpath. 005 006 GNU Classpath is free software; you can redistribute it and/or modify 007 it under the terms of the GNU General Public License as published by 008 the Free Software Foundation; either version 2, or (at your option) 009 any later version. 010 011 GNU Classpath is distributed in the hope that it will be useful, but 012 WITHOUT ANY WARRANTY; without even the implied warranty of 013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 General Public License for more details. 015 016 You should have received a copy of the GNU General Public License 017 along with GNU Classpath; see the file COPYING. If not, write to the 018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 019 02110-1301 USA. 020 021 Linking this library statically or dynamically with other modules is 022 making a combined work based on this library. Thus, the terms and 023 conditions of the GNU General Public License cover the whole 024 combination. 025 026 As a special exception, the copyright holders of this library give you 027 permission to link this library with independent modules to produce an 028 executable, regardless of the license terms of these independent 029 modules, and to copy and distribute the resulting executable under 030 terms of your choice, provided that you also meet, for each linked 031 independent module, the terms and conditions of the license of that 032 module. An independent module is a module which is not derived from 033 or based on this library. If you modify this library, you may extend 034 this exception to your version of the library, but you are not 035 obligated to do so. If you do not wish to do so, delete this 036 exception statement from your version. */ 037 038 039 package java.security.cert; 040 041 /** 042 * Parameters for CertStores that are retrieved via the <i>lightweight 043 * directory access protocol</i> (<b>LDAP</b>). 044 * 045 * @see CertStore 046 */ 047 public class LDAPCertStoreParameters implements CertStoreParameters 048 { 049 050 // Constants and fields. 051 // ------------------------------------------------------------------------ 052 053 /** The default LDAP port. */ 054 private static final int LDAP_PORT = 389; 055 056 /** The server name. */ 057 private final String serverName; 058 059 /** The LDAP port. */ 060 private final int port; 061 062 // Constructors. 063 // ------------------------------------------------------------------------ 064 065 /** 066 * Create a new LDAPCertStoreParameters object, with a servername of 067 * "localhost" and a port of 389. 068 */ 069 public LDAPCertStoreParameters() 070 { 071 this("localhost", LDAP_PORT); 072 } 073 074 /** 075 * Create a new LDAPCertStoreParameters object, with a specified 076 * server name and a port of 389. 077 * 078 * @param serverName The LDAP server name. 079 * @throws NullPointerException If <i>serverName</i> is null. 080 */ 081 public LDAPCertStoreParameters(String serverName) 082 { 083 this(serverName, LDAP_PORT); 084 } 085 086 /** 087 * Create a new LDAPCertStoreParameters object, with a specified 088 * server name and port. 089 * 090 * @param serverName The LDAP server name. 091 * @param port The LDAP port. 092 * @throws NullPointerException If <i>serverName</i> is null. 093 */ 094 public LDAPCertStoreParameters(String serverName, int port) 095 { 096 if (serverName == null) 097 throw new NullPointerException(); 098 this.serverName = serverName; 099 this.port = port; 100 } 101 102 // Instance methods. 103 // ------------------------------------------------------------------------ 104 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 */ 115 public String getServerName() 116 { 117 return serverName; 118 } 119 120 /** 121 * Return the port. 122 * 123 * @return the port. 124 */ 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 */ 135 public String toString() 136 { 137 return "LDAPCertStoreParameters: [ serverName: " + serverName 138 + "; port: " + port + " ]"; 139 } 140 }