TransactionCounter ("Entrust Authority Security Toolkit for the Java Platform")

java.lang.Object
- com.entrust.toolkit.util.TransactionCounter

All Implemented Interfaces:

java.util.Observer
```
public class TransactionCounter
extends java.lang.Object
implements java.util.Observer
```
TransactionCounter is a singleton class that counts the cryptographic operations performed by an application.
The class counts cryptographic operations in the following transaction types:
- Login
- PKCS#7 — encryption, decryption, signing, and verification
- XML — encryption, decryption, signing, and verification
- S/MIME — encryption, decryption, signing, and verification
- SSL — mutual and server authentication
TransactionCounter also records two system properties:
- JDK version
- Operating system
The TransactionCounter class provides a variety of methods for accessing information about transaction counting and system properties.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`LOGIN` Constant for the login transaction
`static int`	`PKCS7_DECRYPTION` Constant for the PKCS#7 decryption transaction
`static int`	`PKCS7_ENCRYPTION` Constant for the PKCS#7 encryption transaction
`static int`	`PKCS7_SIGNING` Constant for the PKCS#7 signing transaction
`static int`	`PKCS7_VERIFICATION` Constant for the PKCS#7 verification transaction
`static int`	`SMIME_DECRYPTION` Constant for the S/MIME decryption transaction
`static int`	`SMIME_ENCRYPTION` Constant for the S/MIME encryption transaction
`static int`	`SMIME_SIGNING` Constant for the S/MIME signing transaction
`static int`	`SMIME_VERIFICATION` Constant for the S/MIME verification transaction
`static int`	`SSL_MUTUAL_AUTHENTICATION` Constant for the SSL client/mutual authentication transaction
`static int`	`SSL_SERVER_AUTHENTICATION` Constant for the SSL server authentication transaction
`static java.lang.String[]`	`TRANSACTION_TYPE` Array of `String` constants for the types of transaction counted by the `TransactionCounter` class
`static int`	`UNKNOWN_TRANSACTION` Constant for any transaction other than those listed
`static int`	`XML_DECRYPTION` Constant for the XML decryption transaction
`static int`	`XML_ENCRYPTION` Constant for the XML encryption transaction
`static int`	`XML_SIGNING` Constant for the XML signing transaction
`static int`	`XML_VERIFICATION` Constant for the XML verification transaction

Constructor Summary

Constructors
Modifier Constructor and Description

protected TransactionCounter()
Creates a TransactionCounter object.

Constructors
Modifier	Constructor and Description
`protected`	`TransactionCounter()` Creates a `TransactionCounter` object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getCount(int transaction_type)` Retrieves the count of the given transaction type.
`static TransactionCounter`	`getInstance()` Retrieves a single instance of the `TransactionCounter` class.
`java.lang.String`	`getJDKVersion()` Retrieves the Java Runtime Environment (JRE) version on which the application is running.
`java.lang.String`	`getOSName()` Retrieves the operating system name on which the application is running.
`boolean`	`isOn()` Retrieves a `boolean` specifying whether the counter is turned on or turned off.
`void`	`registerCounter(java.util.Observable counter)` Adds the given `Observable` to this class.
`void`	`reset()` Resets the counter.
`void`	`setCountingMode(boolean mode)` Sets the value of `m_is_on` to turn the counter on or off.
`java.lang.String`	`toString()` Retrieves the transaction counting and system properties information as a single `String`.
`void`	`update(java.util.Observable observable, java.lang.Object object)` Updates the counter.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOGIN
```
public static final int LOGIN
```
    Constant for the login transaction
    
    See Also:
    
    Constant Field Values
  - PKCS7_SIGNING
```
public static final int PKCS7_SIGNING
```
    Constant for the PKCS#7 signing transaction
    
    See Also:
    
    Constant Field Values
  - PKCS7_VERIFICATION
```
public static final int PKCS7_VERIFICATION
```
    Constant for the PKCS#7 verification transaction
    
    See Also:
    
    Constant Field Values
  - PKCS7_ENCRYPTION
```
public static final int PKCS7_ENCRYPTION
```
    Constant for the PKCS#7 encryption transaction
    
    See Also:
    
    Constant Field Values
  - PKCS7_DECRYPTION
```
public static final int PKCS7_DECRYPTION
```
    Constant for the PKCS#7 decryption transaction
    
    See Also:
    
    Constant Field Values
  - SSL_MUTUAL_AUTHENTICATION
```
public static final int SSL_MUTUAL_AUTHENTICATION
```
    Constant for the SSL client/mutual authentication transaction
    
    See Also:
    
    Constant Field Values
  - SSL_SERVER_AUTHENTICATION
```
public static final int SSL_SERVER_AUTHENTICATION
```
    Constant for the SSL server authentication transaction
    
    See Also:
    
    Constant Field Values
  - UNKNOWN_TRANSACTION
```
public static final int UNKNOWN_TRANSACTION
```
    Constant for any transaction other than those listed
    
    See Also:
    
    Constant Field Values
  - XML_SIGNING
```
public static final int XML_SIGNING
```
    Constant for the XML signing transaction
    
    See Also:
    
    Constant Field Values
  - XML_VERIFICATION
```
public static final int XML_VERIFICATION
```
    Constant for the XML verification transaction
    
    See Also:
    
    Constant Field Values
  - XML_ENCRYPTION
```
public static final int XML_ENCRYPTION
```
    Constant for the XML encryption transaction
    
    See Also:
    
    Constant Field Values
  - XML_DECRYPTION
```
public static final int XML_DECRYPTION
```
    Constant for the XML decryption transaction
    
    See Also:
    
    Constant Field Values
  - SMIME_SIGNING
```
public static final int SMIME_SIGNING
```
    Constant for the S/MIME signing transaction
    
    See Also:
    
    Constant Field Values
  - SMIME_VERIFICATION
```
public static final int SMIME_VERIFICATION
```
    Constant for the S/MIME verification transaction
    
    See Also:
    
    Constant Field Values
  - SMIME_ENCRYPTION
```
public static final int SMIME_ENCRYPTION
```
    Constant for the S/MIME encryption transaction
    
    See Also:
    
    Constant Field Values
  - SMIME_DECRYPTION
```
public static final int SMIME_DECRYPTION
```
    Constant for the S/MIME decryption transaction
    
    See Also:
    
    Constant Field Values
  - TRANSACTION_TYPE
```
public static final java.lang.String[] TRANSACTION_TYPE
```
    Array of String constants for the types of transaction counted by the TransactionCounter class
- Constructor Detail
  - TransactionCounter
```
protected TransactionCounter()
```
    Creates a TransactionCounter object.
    The access specifier for this constructor is protected to prevent others from instantiating this class.
- Method Detail
  - getInstance
```
public static TransactionCounter getInstance()
```
    Retrieves a single instance of the TransactionCounter class.
    
    Returns:
    
    A TransactionCounter instance.
  - setCountingMode
```
public void setCountingMode(boolean mode)
```
    Sets the value of m_is_on to turn the counter on or off.
    
    Parameters:
    
    mode - true to turn on the counter, or false to turn off the counter.
  - update
```
public void update(java.util.Observable observable,
                   java.lang.Object object)
```
    Updates the counter.
    update updates the counter corresponding to the given transaction type if the counter is on. The method does nothing if the counter is turned off.
    
    Specified by:
    
    update in interface java.util.Observer
    
    Parameters:
    
    observable - An object of class Observable for counting the transaction activities performed by the classes in a specific package.
    
    object - An Integer whose int value identifies the transaction activity just performed.
  - getCount
```
public int getCount(int transaction_type)
```
    Retrieves the count of the given transaction type.
    
    Parameters:
    
    transaction_type - an integer between 0 and num_transaction_type - 1 specifying the type of the transaction.
    
    Returns:
    
    An int representing the transaction count.
  - getJDKVersion
```
public java.lang.String getJDKVersion()
```
    Retrieves the Java Runtime Environment (JRE) version on which the application is running.
    
    Returns:
    
    A String representing the JRE version.
  - getOSName
```
public java.lang.String getOSName()
```
    Retrieves the operating system name on which the application is running.
    
    Returns:
    
    A String representing the operating system name.
  - isOn
```
public boolean isOn()
```
    Retrieves a boolean specifying whether the counter is turned on or turned off.
    
    Returns:
    
    A boolean, true or false.
  - toString
```
public java.lang.String toString()
```
    Retrieves the transaction counting and system properties information as a single String.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String listing transaction counting and system properties information.
  - registerCounter
```
public void registerCounter(java.util.Observable counter)
```
    Adds the given Observable to this class.
    
    Parameters:
    
    counter - An Observable instance to be added to the Observer list.
  - reset
```
public void reset()
```
    Resets the counter.

Class TransactionCounter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGIN

PKCS7_SIGNING

PKCS7_VERIFICATION

PKCS7_ENCRYPTION

PKCS7_DECRYPTION

SSL_MUTUAL_AUTHENTICATION

SSL_SERVER_AUTHENTICATION

UNKNOWN_TRANSACTION

XML_SIGNING

XML_VERIFICATION

XML_ENCRYPTION

XML_DECRYPTION

SMIME_SIGNING

SMIME_VERIFICATION

SMIME_ENCRYPTION

SMIME_DECRYPTION

TRANSACTION_TYPE

Constructor Detail

TransactionCounter

Method Detail

getInstance

setCountingMode

update

getCount

getJDKVersion

getOSName

isOn

toString

registerCounter

reset