eu.emi.client.security
Interface IClientProperties

All Superinterfaces:

Cloneable, IAuthenticationConfiguration, ISecurityConfiguration

All Known Subinterfaces:

ISecurityProperties

All Known Implementing Classes:

ClientSecurityProperties

public interface IClientProperties
extends IAuthenticationConfiguration

Provides additional to pure security settings for the client:

• whether to initialize SSL or not
• list of outgoing and incoming handlers
• classloader to be used in case of loading handler classes
• settings to automatically initialize signing of outgoing messages.
• settings to automatically initialize ETD for outgoing messages.

TODO - this class does not fit in this module. It is here only as it is extended in use-core. Should be moved to secutils-xfire (but use-core doesn't depend on it).

Author:

golbi

Method Summary

IClientProperties	clone() Makes a copy of these properties.
boolean	doSignMessage() Digital signature mechanism can be disabled with this method returning false.
X509Certificate[]	getCertificateChain() the user's certificate chain.
ClassLoader	getClassLoader() Get the classloader to be used e.g.
Map<String,Object>	getExtraSecurityTokens() For outgoing calls, get extra security information.
Properties	getExtraSettings() Returns additional settings which are used to set up the client call (e.g., HTTP client proxy settings or additional security handler settings)
String	getInHandlerClassNames() Returns the names of the security handler classes for incoming messages, separated by a single space.
String	getOutHandlerClassNames() Returns the names of the security handler classes for outbound messages, separated by a single space.
PrivateKey	getPrivateKey() private key for signing messages and assertions
X509Certificate	getPublicKey() the user's certificate, equal to the first entry in the certificate chain (this is equivalent to calling getCertificateChain()[0])
boolean	isSslEnabled() Returns true if SSL mode is enabled.

Methods inherited from interface eu.emi.client.security.IAuthenticationConfiguration

doHttpAuthn, doSSLAuthn, getHttpPassword, getHttpUser, getSSLContext, getTruststore, getTruststorePassword, getTruststoreType

Methods inherited from interface eu.emi.client.security.ISecurityConfiguration

getKeystore, getKeystoreAlias, getKeystoreKeyPassword, getKeystorePassword, getKeystoreType

Method Detail

clone

IClientProperties clone()

Makes a copy of these properties.

Specified by:

clone in interface IAuthenticationConfiguration

Specified by:

clone in interface ISecurityConfiguration

getOutHandlerClassNames

String getOutHandlerClassNames()

Returns the names of the security handler classes for outbound messages, separated by a single space.

getInHandlerClassNames

String getInHandlerClassNames()

Returns the names of the security handler classes for incoming messages, separated by a single space.

getClassLoader

ClassLoader getClassLoader()

Get the classloader to be used e.g. for dynamically loading security handlers.

isSslEnabled

boolean isSslEnabled()

Returns true if SSL mode is enabled.

doSignMessage

boolean doSignMessage()

Digital signature mechanism can be disabled with this method returning false.

getPrivateKey

PrivateKey getPrivateKey()

private key for signing messages and assertions

Returns:

PrivateKey

getCertificateChain

X509Certificate[] getCertificateChain()

the user's certificate chain.

Returns:

array of X509Certificates

getPublicKey

X509Certificate getPublicKey()

the user's certificate, equal to the first entry in the certificate chain (this is equivalent to calling getCertificateChain()[0])

Returns:

X509Certificate

getExtraSettings

Properties getExtraSettings()

Returns additional settings which are used to set up the client call (e.g., HTTP client proxy settings or additional security handler settings)

Returns:

see above

See Also:

HttpUtils, XFireClientFactory

getExtraSecurityTokens

Map<String,Object> getExtraSecurityTokens()

For outgoing calls, get extra security information. This map is used whenever specialized objects are to be passed to the additional handlers which were configured by this class.