org.xipki.security

Interface ConcurrentContentSigner

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

DfltConcurrentContentSigner

public interface ConcurrentContentSigner
extends Closeable

Concurrent ContentSigner.

Since:

2.0.0

Author:

Lijun Liao

Method Summary

Modifier and Type	Method and Description
ConcurrentBagEntrySigner	borrowSigner() Borrows a signer with implementation-dependent default timeout.
ConcurrentBagEntrySigner	borrowSigner(int soTimeout) Borrows a signer with the given soTimeout.
AlgorithmCode	getAlgorithmCode() Returns the algorithm code in XiPKI context.
String	getAlgorithmName()
X509Cert	getCertificate()
X509Cert[]	getCertificateChain()
String	getName()
PublicKey	getPublicKey()
byte[]	getSha1OfMacKey()
Key	getSigningKey() Get the signing key.
void	initialize(String conf, org.xipki.password.PasswordResolver passwordResolver) Initializes me.
boolean	isHealthy()
boolean	isMac()
void	requiteSigner(ConcurrentBagEntrySigner signer)
void	setCertificateChain(X509Cert[] certchain) Set the CertificateChain.
void	setPublicKey(PublicKey publicKey) Sets the public key.
byte[]	sign(byte[] data) Sign the data.
byte[][]	sign(byte[][] data) Sign the data.

Methods inherited from interface java.io.Closeable

close

Method Detail

getName

String getName()

getAlgorithmName

String getAlgorithmName()

getAlgorithmCode

AlgorithmCode getAlgorithmCode()

Returns the algorithm code in XiPKI context.

Returns:

algorithm code

isMac

boolean isMac()

getSha1OfMacKey

byte[] getSha1OfMacKey()

getSigningKey

Key getSigningKey()

Get the signing key.

Returns:

the signing key if possible. null may be returned.

setPublicKey

void setPublicKey(PublicKey publicKey)

Sets the public key.

Parameters:

publicKey - Public key of this signer. Must not be null.

getPublicKey

PublicKey getPublicKey()

getCertificate

X509Cert getCertificate()

setCertificateChain

void setCertificateChain(X509Cert[] certchain)

Set the CertificateChain.

Parameters:

certchain - Certificate chain of this signer. Could be null.

getCertificateChain

X509Cert[] getCertificateChain()

initialize

void initialize(String conf,
                org.xipki.password.PasswordResolver passwordResolver)
         throws XiSecurityException

Initializes me.

Parameters:

conf - Configuration. Could be null.

passwordResolver - Password resolver. Could be null.

Throws:

XiSecurityException - if error during the initialization occurs.

sign

byte[] sign(byte[] data)
     throws NoIdleSignerException,
            SignatureException

Sign the data.

Parameters:

data - Data to be signed. Must not be null.

Returns:

the signature

Throws:

NoIdleSignerException - If no idle signer is available

SignatureException - if could not sign the data.

sign

byte[][] sign(byte[][] data)
       throws NoIdleSignerException,
              SignatureException

Sign the data.

Parameters:

data - Data to be signed. Must not be null.

Returns:

the signature

Throws:

NoIdleSignerException - If no idle signer is available

SignatureException - if could not sign the data.

borrowSigner

ConcurrentBagEntrySigner borrowSigner()
                               throws NoIdleSignerException

Borrows a signer with implementation-dependent default timeout.

Returns:

the signer

Throws:

NoIdleSignerException - If no idle signer is available

borrowSigner

ConcurrentBagEntrySigner borrowSigner(int soTimeout)
                               throws NoIdleSignerException

Borrows a signer with the given soTimeout.

Parameters:

soTimeout - timeout in milliseconds, 0 for infinitely.

Returns:

the signer

Throws:

NoIdleSignerException - If no idle signer is available

requiteSigner

void requiteSigner(ConcurrentBagEntrySigner signer)

isHealthy

boolean isHealthy()