org.systinet.wasp.mgmt
Interface ServerPreferences

All Known Subinterfaces:

AdminService

public interface ServerPreferences

This interface represents component which is able to set/get global preferences for WSO2 SOA Enablement Server. Each preference is identified by unique tuple stored in PrefsMetadata class. Preferences are stored in DOM. Java WSO2 SOA Enablement Server client can wrap a preference DOM by Java Proxy bean that implements interface stored in PrefsMetadata.configurationIface only. Java WSO2 SOA Enablement Server client can use com.systinet.wasp.mgmt.preferences.PreferencesHelper helper class too - see WSO2 SOA Enablement Server documentation, section Admin Service.

List of all known preferences
preference name	preference type	preference subtype	Java Proxy bean interface
ConfigStore	module	ConfigStore	com.idoox.config.xml.ConfigStoreConfig
HotDeployment	module	HotDeployer	com.systinet.wasp.admin.hotdeploy.HotDeployerConfig
DefaultProtocolProperties	preferences	main	PreferencesConfig}
SecurityPreferences	securityPreferences	main	SecurityModuleConfig
SecurityAccessControllers	securityPreferences	main	com.systinet.wasp.mgmt.preferences.security.AccessControllers
SecurityPStoreInitParams	securityPreferences	main	com.systinet.wasp.mgmt.preferences.security.PStoreInitParams
SecurityUpdateablePolicy	securityPreferences	main	com.systinet.wasp.mgmt.preferences.security.UpdateablePolicy
SecurityProperties	securityPreferences	main	com.systinet.wasp.mgmt.preferences.security.Properties
SecurityProviders	securityPreferences	main	com.systinet.wasp.mgmt.preferences.security.SecurityProviders
SecurityHttpDigest	securityProviderPreferences	HttpDigest	HttpDigestConfig
SecurityKerberosProvider	securityProviderPreferences	Kerberos	KerberosConfig
SecurityWS-Security	securityProviderPreferences	WS-Security	WSSEGlobalConf
TransportFileClient	transport	file_client	TransportConfig
TransportHTTPClient	transport	http_client	HttpClientConfig
TransportHTTPServer	transport	http_server	HttpServerConfig
TransportHTTPSClient	httpsPreferences	main	HttpsClientConfig
TransportHTTPSServer	httpsPreferences	main	HttpsServerConfig
TransportJarClient	transport	jar_client	TransportConfig
TransportJdkClient	transport	default_client	TransportConfig
TransportJMS	transport	jms	JMSConfig
TransportMail	transport	mail	MailConfig
TransportPOPClient	transport	pop_client	PopClientConfig
TransportSMTPClient	transport	smtp_client	SmtpClientConfig

Since:

4.5

See Also:

PrefsMetadata

Component:

Mgmt-Services

Method Summary

org.w3c.dom.Element	getPreferences(PrefsMetadata prefs) Gets particular preferences.
PrefsMetadata[]	getPrefsMetadata() Gets metadata about preferences.
java.lang.String[]	setPreferences(PrefsMetadata prefs, org.w3c.dom.Element elem) Sets particular preferences.

Method Detail

getPrefsMetadata

public PrefsMetadata[] getPrefsMetadata()
                                 throws AdminServiceException

Gets metadata about preferences. PrefsMetadata describes all currently available preference. Preference is unavailable its providing component is not deployed.

Returns:

array of metadata of available preferences

Throws:

AdminServiceException - unable to get preferences metadata

See Also:

PrefsMetadata

getPreferences

public org.w3c.dom.Element getPreferences(PrefsMetadata prefs)
                                   throws AdminServiceException

Gets particular preferences.

Parameters:

prefs - identification of required preference

Returns:

preference stored in DOM element

Throws:

AdminServiceException - unable to get requested preferences

See Also:

PrefsMetadata

setPreferences

public java.lang.String[] setPreferences(PrefsMetadata prefs,
                                         org.w3c.dom.Element elem)
                                  throws AdminServiceException

Sets particular preferences. If setting of preference is not complete (i.e., a preference's property cannot be set,...) a warning(s) is returned. Warning is not an error and can be omited. An exception can be thrown if set cannot be done because of serious error.

Parameters:

elem - preference stored in DOM element

prefs - identification of setting preference

Returns:

returns an array of Strings containing a textual warning(s) if a preference cannot be set. This value can be ignored.

Throws:

AdminServiceException - unable to set requested preferences (including validation problem)

See Also:

PrefsMetadata