org.nhindirect.stagent
Interface MutableAgent

All Known Implementing Classes:

DefaultNHINDAgent

public interface MutableAgent

Defines an interface for modifying agent properties. Care should be taken when implementing this interface to ensure thread safe operation of agent modification.

Since:

1.3

Author:

Greg Meyer

Method Summary

Cryptographer	getCryptographer() Gets the Cryptographer used by the agent to perform cryptography operations.
Collection<String>	getDomains() Gets the list of domains that the agent is serving.
NHINDAgentEventListener	getEventListener() Sets the event listener that will receive notifications at different stages of message processing.
org.nhindirect.policy.PolicyFilter	getPolicyFilter() Gets the policy filter engine for the agent.
CertificateResolver	getPrivateCertResolver() Gets the certificate store used to decrypt and sign messages.
PolicyResolver	getPrivatePolicyResolver() Gets the policy resolvers for privately discovered certificates
Collection<CertificateResolver>	getPublicCertResolvers() Gets the certificate stores used to encrypt messages and validate signatures.
PolicyResolver	getPublicPolicyResolver() Gets the policy resolver for publicly discovered certificates
TrustAnchorResolver	getTrustAnchors() Gets the certificate store that contains the certificate anchors that validate if certificates are trusted.
TrustModel	getTrustModel() Gets the trust model for enforcing message trust
boolean	isWrappingEnabled() Indicates if the agent automatically wraps messages into RFC822 envelopes for hiding headers.
void	setCryptographer(Cryptographer cryptographer) Sets the Cryptographer used by the agent to perform cryptography operations.
void	setDomains(Collection<String> domains) Sets the list of domain that the agent is serving.
void	setEventListener(NHINDAgentEventListener listener) Sets the event listener that will receive notifications at different stages of message processing.
void	setPolicyFilter(org.nhindirect.policy.PolicyFilter filter) Sets the policy filter engine for the agent.
void	setPrivateCertResolver(CertificateResolver resolver) Sets the certificate store used to decrypt and sign messages.
void	setPrivatePolicyResolver(PolicyResolver privatePolicyResolver) Sets the policy resolvers for privately discovered certificates
void	setPublicCertResolvers(Collection<CertificateResolver> resolvers) Sets the certificate stores used to encrypt messages and validate signatures.
void	setPublicPolicyResolver(PolicyResolver publicPolicyResolver) Sets the policy resolver for publicly discovered certificates
void	setTrustAnchorResolver(TrustAnchorResolver resolver) Sets the certificate store that contains the certificate anchors that validate if certificates are trusted.
void	setTrustModel(TrustModel trustModel) Sets the trust model for enforcing message trust
void	setWrappingEnabled(boolean wrappingEnabled) Sets the auto message wrapping feature of the agent.

Method Detail

getDomains

Collection<String> getDomains()

Gets the list of domains that the agent is serving.

Returns:

The domains that the agent is serving.

setDomains

void setDomains(Collection<String> domains)

Sets the list of domain that the agent is serving.

Parameters:

domains - The list of domain that the agent is serving.

getCryptographer

Cryptographer getCryptographer()

Gets the Cryptographer used by the agent to perform cryptography operations.

Returns:

The Cryptographer used by the agent to perform cryptography operations.

setCryptographer

void setCryptographer(Cryptographer cryptographer)

Sets the Cryptographer used by the agent to perform cryptography operations.

Parameters:

cryptographer - The Cryptographer used by the agent to perform cryptography operations.

getPublicCertResolvers

Collection<CertificateResolver> getPublicCertResolvers()

Gets the certificate stores used to encrypt messages and validate signatures. This store generally contains only public certificates

Returns:

The certificate stores used to encrypt messages and validate signatures.

setPublicCertResolvers

void setPublicCertResolvers(Collection<CertificateResolver> resolvers)

Sets the certificate stores used to encrypt messages and validate signatures. This store generally contains only public certificates

Parameters:

resolvers - The certificate stores used to encrypt messages and validate signatures.

getPrivateCertResolver

CertificateResolver getPrivateCertResolver()

Gets the certificate store used to decrypt and sign messages. Certificates in this store must have access to the certifcate's private key.

Returns:

The certificate store used to decrypt and sign messages.

setPrivateCertResolver

void setPrivateCertResolver(CertificateResolver resolver)

Sets the certificate store used to decrypt and sign messages. Certificates in this store must have access to the certifcate's private key.

Parameters:

resolver - The certificate store used to decrypt and sign messages.

getTrustAnchors

TrustAnchorResolver getTrustAnchors()

Gets the certificate store that contains the certificate anchors that validate if certificates are trusted.

Returns:

The certificate store that contains the certificate anchors that validate if certificates are trusted.

setTrustAnchorResolver

void setTrustAnchorResolver(TrustAnchorResolver resolver)

Sets the certificate store that contains the certificate anchors that validate if certificates are trusted.

Parameters:

resolver - The certificate store that contains the certificate anchors that validate if certificates are trusted.

setEventListener

void setEventListener(NHINDAgentEventListener listener)

Sets the event listener that will receive notifications at different stages of message processing.

Parameters:

listener - A concrete implementation of an NHINDAgentEventListener.

getEventListener

NHINDAgentEventListener getEventListener()

Sets the event listener that will receive notifications at different stages of message processing.

Returns:

A concrete implementation of an NHINDAgentEventListener.

setWrappingEnabled

void setWrappingEnabled(boolean wrappingEnabled)

Sets the auto message wrapping feature of the agent. Message wrapping takes the original message and wraps it into a message of type RFC822 pushing all headers into the message body. Only routing information is propagated up from the original message.

Parameters:

wrappingEnabled - True if the agent automatically wraps messages. False otherwise.

isWrappingEnabled

boolean isWrappingEnabled()

Indicates if the agent automatically wraps messages into RFC822 envelopes for hiding headers.

Returns:

True if the agent automatically wraps messages.

setPublicPolicyResolver

void setPublicPolicyResolver(PolicyResolver publicPolicyResolver)

Sets the policy resolver for publicly discovered certificates

Parameters:

publicPolicyResolver - The policy resolver for publicly discovered certificates

getPublicPolicyResolver

PolicyResolver getPublicPolicyResolver()

Gets the policy resolver for publicly discovered certificates

Returns:

The policy resolver for publicly discovered certificates

setPrivatePolicyResolver

void setPrivatePolicyResolver(PolicyResolver privatePolicyResolver)

Sets the policy resolvers for privately discovered certificates

Parameters:

privatePolicyResolver - The policy resolvers for privately discovered certificates

getPrivatePolicyResolver

PolicyResolver getPrivatePolicyResolver()

Gets the policy resolvers for privately discovered certificates

Returns:

The policy resolvers for privately discovered certificates

setPolicyFilter

void setPolicyFilter(org.nhindirect.policy.PolicyFilter filter)

Sets the policy filter engine for the agent.

Parameters:

filter - The policy filter engine for the agent.

getPolicyFilter

org.nhindirect.policy.PolicyFilter getPolicyFilter()

Gets the policy filter engine for the agent.

Returns:

The policy filter engine for the agent.

setTrustModel

void setTrustModel(TrustModel trustModel)

Sets the trust model for enforcing message trust

Parameters:

trustModel - The trust model for enforcing message trust

getTrustModel

TrustModel getTrustModel()

Gets the trust model for enforcing message trust

Returns:

The trust model for enforcing message trust