net.rim.device.api.userauthenticator
Class UserAuthenticatorContextObject

java.lang.Object
  net.rim.device.api.util.LongHashtable
      net.rim.device.api.userauthenticator.UserAuthenticatorContextObject

All Implemented Interfaces:

Persistable

public final class UserAuthenticatorContextObject
extends LongHashtable

Context objects employed to pass generic data between a user authenticator and the security framework.

The security system uses these context objects to contain a variable amount of information, including named objects, that user authenticators and the security framework can refer to by a long key.

Constants in this class
The constants defined in this class are provided for passing to the put, get, and remove methods inherited from LongHashtable, to indicate the type of information inserted into the context. In this way, each context object can hold a single instance of each type of object described here.

See Also:

UserAuthenticator.initialize(net.rim.device.api.userauthenticator.SecurityUIManager, net.rim.device.api.util.DataBuffer, net.rim.device.api.util.DataBuffer, net.rim.device.api.userauthenticator.UserAuthenticatorContextObject), UserAuthenticator.initializeImpl(net.rim.device.api.userauthenticator.SecurityUIManager, net.rim.device.api.util.DataBuffer, net.rim.device.api.util.DataBuffer, net.rim.device.api.userauthenticator.UserAuthenticatorContextObject), UserAuthenticator.authenticate(net.rim.device.api.userauthenticator.SecurityUIManager, net.rim.device.api.util.DataBuffer, net.rim.device.api.userauthenticator.UserAuthenticatorContextObject), UserAuthenticator.authenticateImpl(net.rim.device.api.userauthenticator.SecurityUIManager, net.rim.device.api.util.DataBuffer, net.rim.device.api.userauthenticator.UserAuthenticatorContextObject)

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

Field Summary
	static long	FIELD_PROVIDER_FIELD Indicates a field object.
	static long	PASSWORD Indicates the User Authenticator Password.

Constructor Summary
	UserAuthenticatorContextObject() Construct a new, empty context object / hashtable with a default capacity and load factor.
	UserAuthenticatorContextObject(int initialCapacity) Construct a new, empty context object / hash table with the specified capacity.
	UserAuthenticatorContextObject(UserAuthenticatorContextObject context) Construct a new context object / hashtable based on the contents of the given context.

Method Summary

Methods inherited from class net.rim.device.api.util.LongHashtable

clear, contains, containsKey, elements, get, getKey, isEmpty, keys, keysToArray, put, rehash, remove, resetElements, size

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_PROVIDER_FIELD

public static final long FIELD_PROVIDER_FIELD

Indicates a field object.

If the user authenticator provides a field, the security system passes this field back to the authenticator when invoking its initialize method. The authenticator can use the settings within the field, if needed.

The authenticator should mark the field as clean (invoking setDirty(false) on the field), if it does not wish to be called back.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

PASSWORD

public static final long PASSWORD

Indicates the User Authenticator Password.

This context gets used to pass the password to the initializeImpl, authenticateImpl and verifyPolicySettingsImpl methods.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

Constructor Detail

UserAuthenticatorContextObject

public UserAuthenticatorContextObject(int initialCapacity)

Construct a new, empty context object / hash table with the specified capacity.

Parameters:

initialCapacity - Initial capacity of the context / hashtable.

Throws:

IllegalArgumentException - If the initial capacity is less than zero

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 6.0.0

UserAuthenticatorContextObject

public UserAuthenticatorContextObject()

Construct a new, empty context object / hashtable with a default capacity and load factor.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 6.0.0

UserAuthenticatorContextObject

public UserAuthenticatorContextObject(UserAuthenticatorContextObject context)

Construct a new context object / hashtable based on the contents of the given context.

The context / hashtable itself is copied, however, the references to the objects in the original context / hashtable are referred to by the new context / hashtable.

Parameters:

context - Source context.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 6.0.0