Nuxeo Enterprise Platform 5.4

org.nuxeo.runtime.remoting
Interface Server

All Known Implementing Classes:
ServerImpl

public interface Server

Author:
Bogdan Stefanescu

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

java.lang.String getName()

getDescription

java.lang.String getDescription()

getComponents

ComponentName[] getComponents()

hasComponent

boolean hasComponent(ComponentName name)

getActiveComponents

java.util.Collection<ComponentInstance> getActiveComponents()

getRegistrations

java.util.Collection<RegistrationInfo> getRegistrations()

getServerAddress

java.lang.String getServerAddress()

getComponent

ComponentInstance getComponent(java.lang.String name)

getComponent

ComponentInstance getComponent(ComponentName name)

getProductInfo

java.lang.String getProductInfo()
Gets the product info as a string of the form: ProductName ProductVersion.

Returns:
the product info

getServiceBindings

java.lang.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

java.util.Properties[] getServiceHosts()
                                       throws java.lang.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:
    java.lang.Exception

  • getSecurityDomains

    java.util.Map<java.lang.String,java.lang.Object[][]> getSecurityDomains()
                                                                            throws java.lang.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:
    java.lang.Exception
    See Also:
    AppConfigurationEntry, SecurityDomain

    getProperties

    java.util.Properties getProperties()
    Gets the runtime properties as a Java properties file content.


    getClass

    byte[] getClass(ComponentName component,
                    java.lang.String name)

    getResource

    byte[] getResource(ComponentName component,
                       java.lang.String name)

    getLocalResource

    byte[] getLocalResource(ComponentName component,
                            java.lang.String name)

    Nuxeo Enterprise Platform 5.4

    Copyright © 2010 Nuxeo SAS. All Rights Reserved.