com.softwareag.entirex.aci
Interface BrokerSecurity

All Known Implementing Classes:
EntireXSecurity

public interface BrokerSecurity

Interface which defines the interface to EntireX Security.
A security object used by Java ACI must implement this interface.
The class EntireXSecurity implements this interface and supports the standard EntireX Security.

See Also:
EntireXSecurity, getSecurityToken()

Method Summary
 void decryptData(byte[] data)
          Decrypts the received data in place.
 void encryptData(byte[] data)
          Encrypts the sent data in place.
 byte[] getNewpassword()
          Returns the encrypted Newpassword if it was supplied in the prepareLogon call.
 byte[] getPassword()
          Returns the encrypted password if it was supplied in the prepareLogon call.
 byte[] getSecurityToken()
          Returns a Security Token.
 void prepareLogon(java.lang.String userID, byte[] password, byte[] newpassword, byte[] securityToken)
          Encrypts the password(s) and generates a security token.
 

Method Detail

prepareLogon

void prepareLogon(java.lang.String userID,
                  byte[] password,
                  byte[] newpassword,
                  byte[] securityToken)
Encrypts the password(s) and generates a security token.
This method is always called inside the Broker logon methods. It is called before performing a logon call to the Broker. This method prepares the encryption of the password and the new password and the generation of the security token. These values will be retrieved by the getPassword, getNewpassword and getSecurityToken methods.

Parameters:
userID - user ID from Broker constructor.
password - Password from logon method. May be null.
newpassword - New password from logon method. May be null.
securityToken - Security token from Broker object. May be null.
See Also:
Broker.logon(), Broker.logon(java.lang.String), Broker.logon(java.lang.String, java.lang.String), getPassword(), getNewpassword(), getSecurityToken()

getPassword

byte[] getPassword()
Returns the encrypted password if it was supplied in the prepareLogon call.

Returns:
The encrypted password or null.
See Also:
prepareLogon(java.lang.String, byte[], byte[], byte[])

getNewpassword

byte[] getNewpassword()
Returns the encrypted Newpassword if it was supplied in the prepareLogon call.

Returns:
The encrypted new password or null.
See Also:
prepareLogon(java.lang.String, byte[], byte[], byte[])

getSecurityToken

byte[] getSecurityToken()
Returns a Security Token.

Returns:
The Security Token.
See Also:
prepareLogon(java.lang.String, byte[], byte[], byte[])

encryptData

void encryptData(byte[] data)
Encrypts the sent data in place.

Parameters:
data - The send data.

decryptData

void decryptData(byte[] data)
Decrypts the received data in place.

Parameters:
data - The receive data.