org.nuxeo.runtime.remoting
Interface Server

All Known Implementing Classes:

ServerImpl

public interface Server

Author:

Bogdan Stefanescu

Method Summary

Collection<ComponentInstance>	getActiveComponents()
byte[]	getClass(ComponentName component, String name)
ComponentInstance	getComponent(ComponentName name)
ComponentInstance	getComponent(String name)
ComponentName[]	getComponents()
ServerConfiguration	getConfiguration(InvokerLocator locator, Version version)
String	getDescription()
byte[]	getLocalResource(ComponentName component, String name)
String	getName()
String	getProductInfo() Gets the product info as a string of the form: ProductName ProductVersion.
Properties	getProperties() Gets the runtime properties as a Java properties file content.
Collection<RegistrationInfo>	getRegistrations()
byte[]	getResource(ComponentName component, String name)
Map<String,Object[][]>	getSecurityDomains() Gets the login configuration of this server.
String	getServerAddress()
String[]	getServiceBindings() Returns the service binding configuration as a string array containing the following informations: [group, serviceInterface, name, locator], [group, serviceInterface, name, locator], ...
Properties[]	getServiceHosts() Returns the service locators as an array of service locator properties.
boolean	hasComponent(ComponentName name)

Method Detail

getConfiguration

ServerConfiguration getConfiguration(InvokerLocator locator,
                                     Version version)
                                     throws ConfigurationException

Throws:

ConfigurationException

getName

String getName()

getDescription

String getDescription()

getComponents

ComponentName[] getComponents()

hasComponent

boolean hasComponent(ComponentName name)

getActiveComponents

Collection<ComponentInstance> getActiveComponents()

getRegistrations

Collection<RegistrationInfo> getRegistrations()

getServerAddress

String getServerAddress()

getComponent

ComponentInstance getComponent(String name)

getComponent

ComponentInstance getComponent(ComponentName name)

getProductInfo

String getProductInfo()

Gets the product info as a string of the form: ProductName ProductVersion.

Returns:

the product info

getServiceBindings

String[] getServiceBindings()

Returns the service binding configuration as a string array containing the following informations:

 [group, serviceInterface, name, locator], [group, serviceInterface, name, locator], ...
 

So each service binding takes 4 consecutive entries in the array.

Returns:

the service bindings

getServiceHosts

Properties[] getServiceHosts()
                             throws Exception

Returns the service locators as an array of service locator properties.

There are 4 special properties that can be used:

@class - the service locator class name (a String)

@host - the server host (a String)

@port - the server port (an Integer)

@groups - the server service groups (a String array)

Returns:

an array containing the service locators descriptor properties

Throws:

Exception

getSecurityDomains

Map<String,Object[][]> getSecurityDomains()
                                          throws Exception

Gets the login configuration of this server. The login configuration is a map of SecurityDomain. A security domains is defined by a name and an array of AppConfigurationEntry objects

Since these objects are not serializable they will be represented as an Object[] array of 3 elements:

1. the login module name stored as a String
2. the login module control flag stored as a String
3. the login module options stored as a Map

So the entry value in the returned map is an Object[3][] array of 3 length object arrays describing the AppConfigurationEntry.

Returns:

a map describing the security domains available on the server

Throws:

Exception

See Also:

AppConfigurationEntry, SecurityDomain

getProperties

Properties getProperties()

Gets the runtime properties as a Java properties file content.

getClass

byte[] getClass(ComponentName component,
                String name)

getResource

byte[] getResource(ComponentName component,
                   String name)

getLocalResource

byte[] getLocalResource(ComponentName component,
                        String name)