SHOW Signed

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

java.lang.Object
  |
  +--net.rim.device.api.crypto.certificate.CertificateServers

All Implemented Interfaces:

Persistable, net.rim.vm.Persistable

public final class CertificateServers

extends Object

implements Persistable

This class is used to store the certificate servers so that we can ensure that they are maintained on the device through resets.

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

See Also:

CertificateServerInfo, CertificateFactory

Field Summary

	static int	CRL_SERVER An integer representing the CRL server type.
	static int	DELETED_SERVER An integer representing the Deleted servers.
	static int	LDAP_SERVER An integer representing the LDAP server type.
	static int	OCSP_SERVER An integer representing the OCSP server type.

Method Summary

	void	addCollectionListener(CollectionListener listener)
	CertificateServerInfo	addServer(CertificateServerInfo server) Adds a server to the list of servers.
	CertificateServerInfo	addServer(String server, int type, String friendlyName) Adds a server to the list of servers using the specified parameters.
	CertificateServerInfo	addServer(String server, int type, String friendlyName, String baseQuery, int port) Deprecated.
	CertificateServerInfo	addServer(String server, int type, String friendlyName, String baseQuery, int port, int authType) Adds a server to the list of servers using the specified parameters.
	boolean	contains(CertificateServerInfo server) Returns a boolean that determines if the specified CertificateServerInfo is contained on a server.
	CertificateServerInfo	elementAt(int type, int index) Returns the element at the index specified by the index parameter to the method.
	static CertificateServers	getInstance() Returns an instance of a CertificateServers object.
	Enumeration	getServers(int type) Get an enumeration of servers.
	int	getServerSize(int type) Returns the number of servers of the specified type.
	SyncObject	getSyncObject(int uid) Return the SyncObject that has the given UID.
	SyncObject[]	getSyncObjects() Returns the SyncObjects.
	void	removeAllElements() Removes all elements from the list of servers.
	void	removeCollectionListener(CollectionListener listener)
	boolean	removeServer(CertificateServerInfo server) This method removes an element from the appropriate list of servers, given the server to remove.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LDAP_SERVER

public static final int LDAP_SERVER

An integer representing the LDAP server type.

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.

OCSP_SERVER

public static final int OCSP_SERVER

An integer representing the OCSP server type.

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.

CRL_SERVER

public static final int CRL_SERVER

An integer representing the CRL server type.

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.

DELETED_SERVER

public static final int DELETED_SERVER

An integer representing the Deleted servers.

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

getInstance

public static CertificateServers getInstance()

Returns an instance of a CertificateServers object.

Returns:

A CertificateServers object.

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.

addCollectionListener

public void addCollectionListener(CollectionListener listener)

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.

removeCollectionListener

public void removeCollectionListener(CollectionListener listener)

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.

addServer

public CertificateServerInfo addServer(CertificateServerInfo server)

Adds a server to the list of servers.

Parameters:

server - The server to add to the list.

Returns:

A CertificateServerInfo object containing information about the added server

Throws:

IllegalArgumentException - if the server is null or invalid.

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.

addServer

public CertificateServerInfo addServer(String server,
                                       int type,
                                       String friendlyName)

Adds a server to the list of servers using the specified parameters. This method sets the baseQuery to null, port to 0 and automatically generates the unique identifier ( UID ).

Parameters:

server - A String representing the name of the server, must be non null.

type - The type of server. The currently defined types are: CertificateServers.LDAP_SERVER, CertificateServers.OCSP_SERVER and CertificateServers.CRL_SERVER.

friendlyName - The friendly name of the server, must be non null.

Returns:

A CertificateServerInfo object containing information about the added 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.

addServer

public CertificateServerInfo addServer(String server,
                                       int type,
                                       String friendlyName,
                                       String baseQuery,
                                       int port)

Deprecated.

Adds a server to the list of servers using the specified parameters. This method automatically generates the unique identifier ( UID ).

Parameters:

server - A String representing the name of the server, must be non null.

type - The type of server. The currently defined types are: CertificateServers.LDAP_SERVER, CertificateServers.OCSP_SERVER and CertificateServers.CRL_SERVER.

friendlyName - The friendly name of the server, must be non null.

baseQuery - A String containing the base query of the server, must be non null if the type is CertificateServer.LDAP_SERVER.

port - The port number of the server.

Returns:

A CertificateServerInfo object containing information about the added server

Throws:

IllegalArgumentException - if an invalid type was specified

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.

addServer

public CertificateServerInfo addServer(String server,
                                       int type,
                                       String friendlyName,
                                       String baseQuery,
                                       int port,
                                       int authType)

Adds a server to the list of servers using the specified parameters. This method automatically generates the unique identifier ( UID ).

Parameters:

server - A String representing the name of the server, must be non null.

type - The type of server. The currently defined types are: CertificateServers.LDAP_SERVER, CertificateServers.OCSP_SERVER and CertificateServers.CRL_SERVER.

friendlyName - The friendly name of the server, must be non null.

baseQuery - A String containing the base query of the server, must be non null if the type is CertificateServer.LDAP_SERVER.

port - The port number of the server.

authType - an integer representing the type of authentication to use for this LDAP connection. For example, one can set it to be LDAPQuery.LDAP_AUTH_ANONYMOUS or LDAPQuery.LDAP_AUTH_SIMPLE. Simple authentication will prompt for a username and password.

Returns:

A CertificateServerInfo object containing information about the added server

Throws:

IllegalArgumentException - if an invalid type was specified

Since:

JDE 4.0.0

See Also:

LDAPQuery

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.

contains

public boolean contains(CertificateServerInfo server)

Returns a boolean that determines if the specified CertificateServerInfo is contained on a server.

Parameters:

server - The CertificateServerInfo object.

Returns:

A boolean that returns true if the server is found.

Throws:

IllegalArgumentException - if an invalid type was specified within the server parameter or if the server is null.

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.

elementAt

public CertificateServerInfo elementAt(int type,
                                       int index)

Returns the element at the index specified by the index parameter to the method.

Parameters:

type - The type of the server. The currently defined types are: CertificateServers.LDAP_SERVER, CertificateServers.OCSP_SERVER and CertificateServers.CRL_SERVER.

index - The index of the element.

Returns:

The CertificateServerInfo object. May be null.

Throws:

IllegalArgumentException - if an invalid type was specified

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.

removeServer

public boolean removeServer(CertificateServerInfo server)

This method removes an element from the appropriate list of servers, given the server to remove.

Parameters:

server - The CertificateServerInfo object.

Returns:

A boolean that returns true if the server is removed.

Throws:

IllegalArgumentException - if an invalid type was specified within the server parameter or if the server was null.

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.

getSyncObjects

public SyncObject[] getSyncObjects()

Returns the SyncObjects.

Returns:

An array of SyncObjects.

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.

getSyncObject

public SyncObject getSyncObject(int uid)

Return the SyncObject that has the given UID.

Parameters:

uid - The UID of the SyncObject to retrieve.

Returns:

The SyncObject with the given UID or null if no such SyncObject exists.

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.

removeAllElements

public void removeAllElements()

Removes all elements from the list of servers.

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.

getServerSize

public int getServerSize(int type)

Returns the number of servers of the specified type.

Parameters:

type - the type of server for which to return the size. The currently defined types are: CertificateServers.LDAP_SERVER, CertificateServers.OCSP_SERVER and CertificateServers.CRL_SERVER.

Returns:

An integer that represents the number of servers of the specified type.

Throws:

IllegalArgumentException - if an invalid type was specified

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.

getServers

public Enumeration getServers(int type)

Get an enumeration of servers.

Parameters:

type - the type of servers to get

Returns:

an enumeration of the servers, namely CertificateServerInfo objects.

Throws:

IllegalArgumentException - if an invalid type was specified

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.