net.rim.device.api.crypto.keystore
Class AssociatedData

java.lang.Object
  extended by net.rim.device.api.crypto.keystore.AssociatedData
All Implemented Interfaces:
Persistable, Persistable

public class AssociatedData
extends Object
implements Persistable

Used to provide an aliasing service for the records that are contained inside the keystore. The AssociatedData class allows the user to specify what kind of alias they are using and subsequently allows for more flexible use of this structure with an Index.

Generating longs for AssociatedData classes

The convention used to generate longs for the associated data classes, is for example net.rim.device.api.crypto.keystore.EMAIL. Note the actual data descriptor is in capital letters. This name is then converted into a long using the function provided in the IDE (right click a string). The "common" longs are provided and should be used as much as possible.

See Also:
AssociatedDataKeyStoreIndex
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 3.6.0

Field Summary
Category: Signed static long DESKTOP_COOKIE
          A long representing the desktop cookie associated data.
Category: Signed static long EMAIL
          A long representing the email associated data.
Category: Signed static long HISTORICAL_KEY_ID
          If present, indicates the unique identifier for any historical keys.
Category: Signed static long ISSUER
          A long representing the issuer associated data.
Category: Signed static long NAME
          A long representing the name associated data.
Category: Signed static long PGP_KEY_ID
          A long representing the PGP key ID associated data.
Category: Signed static long PGP_UNIVERSAL_CACHED_KEY_INFO
          A long representing the PGP Universal Server cached key information.
Category: Signed static long SERIAL_NUMBER
          A long representing the serial number associated data.
Category: Signed static long SMART_CARD_KEY
          If present, indicates that this key resides on a smart card.
 
Constructor Summary
Category: Signed AssociatedData(long association, byte[] data)
          Sets the association with the appropriate data for this class.
Category: Signed AssociatedData(long association, byte[][] data)
          Sets the association with the appropriate data for this class.
 
Method Summary
Category: Signed  long getAssociation()
          Returns the association for this data.
Category: Signed  byte[][] getData()
          Returns a copy of the data for this association.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Field Detail

EMAIL

public static final long EMAIL
A long representing the email associated data.

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 3.6.0

NAME

public static final long NAME
A long representing the name associated data.

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 3.6.0

DESKTOP_COOKIE

public static final long DESKTOP_COOKIE
A long representing the desktop cookie associated data.

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 3.6.0

ISSUER

public static final long ISSUER
A long representing the issuer associated data.

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 3.6.0

SERIAL_NUMBER

public static final long SERIAL_NUMBER
A long representing the serial number associated data.

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 3.6.0

SMART_CARD_KEY

public static final long SMART_CARD_KEY
If present, indicates that this key resides on a smart card.

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 3.6.0

HISTORICAL_KEY_ID

public static final long HISTORICAL_KEY_ID
If present, indicates the unique identifier for any historical keys.

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 4.1.0

PGP_KEY_ID

public static final long PGP_KEY_ID
A long representing the PGP key ID associated data.

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 4.1.0

PGP_UNIVERSAL_CACHED_KEY_INFO

public static final long PGP_UNIVERSAL_CACHED_KEY_INFO
A long representing the PGP Universal Server cached key information.

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 4.1.0


Constructor Detail

AssociatedData

public AssociatedData(long association,
                      byte[] data)
Sets the association with the appropriate data for this class.

Parameters:
association - A long representing the association.
data - A byte array containing the data for the association.
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 3.6.0

AssociatedData

public AssociatedData(long association,
                      byte[][] data)
Sets the association with the appropriate data for this class.

Parameters:
association - A long representing the association.
data - A two dimensioanl array containing the data for the association.
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 3.6.0


Method Detail

getAssociation

public long getAssociation()
Returns the association for this data.

Returns:
A long representing the association.
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 3.6.0

getData

public byte[][] getData()
Returns a copy of the data for this association.

Note: This ensures that this class is immutable.

Returns:
A two dimensional array containing the data.
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 3.6.0





Copyright 1999-2010 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. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.