be.SIRAPRISE.client.jsba

Class DBObjectInterfaceGenerator

java.lang.Object

be.SIRAPRISE.client.jsba.DBObjectInterfaceGenerator

All Implemented Interfaces:

Signer

public class DBObjectInterfaceGenerator
extends java.lang.Object
implements Signer

The DBObjectInterfaceGenerator utility helps the developer in writing classes for the java/SIRA_PRISE bridging architecture (abbreviated JSBA) by generating java source files that define an interface for JSBA classes to implement. Without this utility, a programmer must carefully choose the names of the methods that are required by JSBA for a class to cooperate with a SIRA_PRISE relvar. With this utility, the developer can generate the interface definition that corresponds to a given SIRA_PRISE relvar, include that interface definition in his java project and implement the interface methods in his class(es).

Please see the main() method documentation for details on running the utility

Author:

Erwin Smout

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RELVAR The name for the default option when invoking the DBObjectInterfaceGenerator

Method Summary

Modifier and Type	Method and Description
byte[]	decryptSecret(java.security.Signature signature, java.lang.String cipherInfoCipherName, byte[] encryptedSecret) Decrypts an encrypted secret, encryption of which was done using the public key corresponding to the private key we also use to sign messages with
static void	main(java.lang.String[] args) The DBObjectInterfaceGenerator utility helps the developer in writing classes for the java/SIRA_PRISE bridging architecture (abbreviated JSBA) by generating java source files that define an interface for JSBA classes to implement.
byte[]	sign(java.security.Signature signature, byte[] signMessage) Computes the signature for the given byte string and the given Signature.

Methods inherited from class java.lang.Object

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

Field Detail

RELVAR

public static final java.lang.String RELVAR

The name for the default option when invoking the DBObjectInterfaceGenerator

See Also:

Constant Field Values

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

The DBObjectInterfaceGenerator utility helps the developer in writing classes for the java/SIRA_PRISE bridging architecture (abbreviated JSBA) by generating java source files that define an interface for JSBA classes to implement. Without this utility, a programmer must carefully choose the names of the methods that are required by JSBA for a class to cooperate with a SIRA_PRISE relvar. With this utility, the developer can generate the interface definition that corresponds to a given SIRA_PRISE relvar, include that interface definition in his java project and implement the interface methods in his class(es).

This utility writes two files in the specified output directory (see the discussion of the args[] argument). One file is named "DBObjectTo", suffixed with the capitalized relvar name (i.e. the first character in uppercase, all the others in lowercase). The other file is named "ToDBObject", prefixed with the capitalized relvar name.

Parameters:

args - The options for the utility can be passed via the command line using the following syntax for each option : optionname(optionvalue). The following options can be passed :

DBObjectInterfaceGenerator options

Option name	Description	Default value
HOST	The hostname or IP address of the SIRA_PRISE server to which to connect.	LOCALHOST
PORT	The IP port number on the server to which to connect	50000
RELVAR	The name of the relvar for which to generate an interface definition.	no default.
OUTPUTDIRECTORY	The directory where the script processor's output is to be written. This option can only be set on the command line, not in a properties file.	No default

The RELVAR argument can be passed, alternatively, as the first argument and without having to be enclosed in RELVAR() parentheses, as in : DBObjectInterfaceGenerator myrelvar host(...) port(...)

Options that are not specified via the command line, are set from the DBObjectInterfaceGeneratorProperties object.

Throws:

java.io.IOException - -

sign

public byte[] sign(java.security.Signature signature,
                   byte[] signMessage)
            throws java.security.InvalidKeyException,
                   java.security.SignatureException,
                   NotFoundException

Description copied from interface: Signer

Computes the signature for the given byte string and the given Signature. Normally, this involves three method invocations on the given Signature object :

• initSign() the Signature with a PrivateKey object which is to be obtained from private resources
• update() the Signature with the given byte string
• sign() to compute the signature bytes

Specified by:

sign in interface Signer

Parameters:

signature - The Signature object to be used for computing the signature.

signMessage - The message to be signed.

Returns:

the computed signature

Throws:

java.security.InvalidKeyException - If the private key found for signing with this Signature, turns out to be invalid

java.security.SignatureException - If any problem occurred during computation of the signature

NotFoundException - If no private key could be found for signing with this Signature

decryptSecret

public byte[] decryptSecret(java.security.Signature signature,
                            java.lang.String cipherInfoCipherName,
                            byte[] encryptedSecret)
                     throws java.security.InvalidKeyException,
                            java.security.NoSuchAlgorithmException,
                            javax.crypto.NoSuchPaddingException,
                            NotFoundException,
                            javax.crypto.IllegalBlockSizeException,
                            javax.crypto.BadPaddingException

Description copied from interface: Signer

Decrypts an encrypted secret, encryption of which was done using the public key corresponding to the private key we also use to sign messages with

Specified by:

decryptSecret in interface Signer

Parameters:

signature - The Signature object to be used for computing the signature.

cipherInfoCipherName - The name of the Cipher used to encrypt the secret

encryptedSecret - A secret to be shared between [the user of] this signer and a party we are communicating with, and who generated the secret, encrypting it with our public key.

Returns:

The decrypted secret

Throws:

java.security.InvalidKeyException - If the public key in the given certificate is inappropriate for initializing this cipher, or this cipher requires algorithm parameters that cannot be determined from the public key in the given certificate, or the keysize of the public key in the given certificate has a keysize that exceeds the maximum allowable keysize (as determined by the configured jurisdiction policy files).

java.security.NoSuchAlgorithmException - If the cipherInfoCipherName does not indicate a usable Cipher name

javax.crypto.NoSuchPaddingException - If the cipherInfoCipherName does not indicate a usable Cipher name

NotFoundException - If the private key to be used for the decryption could not be found

javax.crypto.IllegalBlockSizeException - If cipherInfoCipherName indicates a block cipher, no padding has been requested (only in encryption mode), and the total input length of the data processed by this cipher is not a multiple of block size; or if this encryption algorithm is unable to process the input data provided.

javax.crypto.BadPaddingException - If this cipher is in decryption mode, and (un)padding has been requested, but the decrypted data is not bounded by the appropriate padding bytes