SHOW Signed

net.rim.device.api.crypto.certificate
Class CertificateServerInfo

java.lang.Object
  |
  +--net.rim.device.api.crypto.certificate.CertificateServerInfo
All Implemented Interfaces:
Persistable, Persistable, SyncObject

public final class CertificateServerInfo
extends Object
implements SyncObject, Persistable

This class represents the objects that are currently stored in the SyncCollection and contains a server, type of server and uid for the record.

Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:
JDE 3.6.0

Constructor Summary
 Category: Signed CertificateServerInfo(String server, int type, int authType, String friendlyName, String baseQuery, int port)
          Creates a new CertificateServerInfo object.
 Category: Signed CertificateServerInfo(String server, int type, String friendlyName)
          Creates a new CertificateServerInfo object.
 Category: Signed CertificateServerInfo(String server, int type, String friendlyName, int uid)
          Deprecated.  
 Category: Signed CertificateServerInfo(String server, int type, String friendlyName, String baseQuery, int port)
          Creates a new CertificateServerInfo object.
 Category: Signed CertificateServerInfo(String server, int type, String friendlyName, String baseQuery, int port, int uid)
          Deprecated.  
 
Method Summary
 Category: Signed  CertificateServerInfo clone()
          This method clones this CertificateServerInfo object exactly.
 Category: Signed static void display(CertificateServerInfo serverInfo)
          Blocks and displays a dialog box containing information about the specified server.
 Category: Signed  boolean equals(Object obj)
          Returns true if obj is equal to the existing object.
 Category: Signed  int getAuthType()
          Returns an integer representing the type of authentication that should be used for this connection.
 Category: Signed  String getBaseQuery()
          Returns the base query of the server.
 Category: Signed  String getFriendlyName()
          Returns the friendly name of the server.
 Category: Signed  int getPort()
          Returns the port number of the server.
 Category: Signed  String getServer()
          Returns a String containing the URL of the server.
 Category: Signed  int getType()
          Returns the type of the server.
 Category: Signed  int getUID()
          Returns the unique ID of the server.
 Category: Signed  int hashCode()
          Returns a hash code value for the object.
 Category: Signed  String toString()
          This method returns a string containing the details in a pretty printed format for display to the user.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CertificateServerInfo

public CertificateServerInfo(String server,
                             int type,
                             int authType,
                             String friendlyName,
                             String baseQuery,
                             int port)
Creates a new CertificateServerInfo object.

Parameters:
server - A String representing the name of the server.
type - An integer representing the type of the object. The currently defined types are: CertificateServers.LDAP_SERVER, CertificateServers.OCSP_SERVER and CertificateServers.CRL_SERVER.
authType - an integer representing the type of authentication to use for this connection. This will most likely be a value from the LDAPQuery such as LDAPQuery.LDAP_AUTH_SIMPLE or LDAPQuery.LDAP_AUTH_ANONYMOUS.
friendlyName - A String representing the friendly name of the server.
baseQuery - A String containing the base query of the server.
port - An integer representing the port number of the server.
uid - A unique ID for the record.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

CertificateServerInfo

public CertificateServerInfo(String server,
                             int type,
                             String friendlyName)
Creates a new CertificateServerInfo object. Sets the base query to be null and the port to be 0.

Parameters:
server - A String representing the URL of the server. It is important to note that the server parameter must be a proper URL or an exception may be thrown when calling display.
type - An integer representing the type of the object. The currently defined types are: CertificateServers.LDAP_SERVER, CertificateServers.OCSP_SERVER and CertificateServers.CRL_SERVER.
friendlyName - A String representing the friendly name of the server.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

CertificateServerInfo

public CertificateServerInfo(String server,
                             int type,
                             String friendlyName,
                             int uid)
Deprecated.  

Creates a new CertificateServerInfo object. Sets the base query to be null and the port to be 0.

Parameters:
server - A String representing the URL of the server. It is important to note that the server parameter must be a proper URL or an exception may be thrown when calling display.
type - An integer representing the type of the object. The currently defined types are: CertificateServers.LDAP_SERVER, CertificateServers.OCSP_SERVER and CertificateServers.CRL_SERVER.
friendlyName - A String representing the friendly name of the server.
uid - A unique ID for the record.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

CertificateServerInfo

public CertificateServerInfo(String server,
                             int type,
                             String friendlyName,
                             String baseQuery,
                             int port)
Creates a new CertificateServerInfo object.

Parameters:
server - A String representing the URL of the server. It is important to note that the server parameter must be a proper URL or an exception may be thrown when calling display.
type - An integer representing the type of the object. The currently defined types are: CertificateServers.LDAP_SERVER, CertificateServers.OCSP_SERVER and CertificateServers.CRL_SERVER.
friendlyName - A String representing the friendly name of the server.
baseQuery - A String containing the base query of the server.
port - An integer representing the port number of the server.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

CertificateServerInfo

public CertificateServerInfo(String server,
                             int type,
                             String friendlyName,
                             String baseQuery,
                             int port,
                             int uid)
Deprecated.  

Creates a new CertificateServerInfo object.

Parameters:
server - A String representing the URL of the server. It is important to note that the server parameter must be a proper URL or an exception may be thrown when calling display.
type - An integer representing the type of the object. The currently defined types are: CertificateServers.LDAP_SERVER, CertificateServers.OCSP_SERVER and CertificateServers.CRL_SERVER.
friendlyName - A String representing the friendly name of the server.
baseQuery - A String containing the base query of the server.
port - An integer representing the port number of the server.
uid - A unique ID for the record.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.
Method Detail

clone

public CertificateServerInfo clone()
This method clones this CertificateServerInfo object exactly. This method should only be used to retrieve a copy of the object and should not be placed into the list of servers unless the existing and previous item no longer exists in the list of servers.
Returns:
the CertificateServerInfo which will be a copy of all of the internal data currently found in this server.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

display

public static void display(CertificateServerInfo serverInfo)
Blocks and displays a dialog box containing information about the specified server.

Parameters:
serverInfo - The server about which information is to be displayed.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

equals

public boolean equals(Object obj)
Returns true if obj is equal to the existing object.
Overrides:
equals in class Object
Since:
JDE 3.6.0

Following copied from class: Object
Parameters:
obj - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.
See Also:
Boolean.hashCode(), Hashtable
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getAuthType

public int getAuthType()
Returns an integer representing the type of authentication that should be used for this connection.
Since:
JDE 4.0.0
See Also:
for authentication types.
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getBaseQuery

public String getBaseQuery()
Returns the base query of the server.

Returns:
A String containing the base query. May be null.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getFriendlyName

public String getFriendlyName()
Returns the friendly name of the server.

Returns:
A String representing the friendly name of the server.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getPort

public int getPort()
Returns the port number of the server.

Returns:
An integer representing the port number.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getServer

public String getServer()
Returns a String containing the URL of the server.

Returns:
A String containing the server url.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getType

public int getType()
Returns the type of the server. The currently defined types are: CertificateServers.LDAP_SERVER, CertificateServers.OCSP_SERVER and CertificateServers.CRL_SERVER.

Returns:
An integer representing the type of the server.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getUID

public int getUID()
Returns the unique ID of the server.

Returns:
An integer representing the UID.
Since:
JDE 3.6.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

hashCode

public int hashCode()
Description copied from class: Object
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Overrides:
hashCode in class Object
Since:
JDE 4.0.0

Following copied from class: Object
Returns:
a hash code value for this object.
See Also:
Object.equals(java.lang.Object), Hashtable
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

toString

public String toString()
This method returns a string containing the details in a pretty printed format for display to the user.
Overrides:
toString in class Object
Returns:
the String containing the details for this certificate server.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.


Copyright 1999-2007 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.