Collaboration API Documentation

com.filenet.bso.collaboration.managementservice.server
Class CollaborationManagementAgent

java.lang.Object
  |
  +--com.filenet.bso.collaboration.managementservice.server.CollaborationManagementAgent

public class CollaborationManagementAgent
extends java.lang.Object


Field Summary
protected static java.lang.String CONFIG_FILE_NAME
           
static java.lang.String CONFIG_PATH_SYSPROP
           
static java.lang.String ENGINE_NAME
           
static java.lang.String HTML_ADAPTOR_URL
           
static java.lang.String JMXMP_CONNECTOR_URL
           
static java.lang.String loggerName
           
static java.lang.String MAILSERVER_NAME
           
static java.lang.String RMI_CONNECTOR_URL
           
 
Constructor Summary
CollaborationManagementAgent()
           
 
Method Summary
 boolean configMailServer()
           
 void create()
          Attach connectors & adaptors to the MBean Server then start them.
 javax.management.ObjectInstance createMBean(java.lang.String className, javax.management.ObjectName objectName, javax.management.ObjectName classLoaderName, java.lang.Object[] params, java.lang.String[] signature)
           
static javax.management.MBeanServerConnection findServer()
          Find the running instance of our JMX Server
static CollaborationManagementAgent getAgent()
           
protected  java.io.InputStream getConfigFileStream()
           
protected  java.lang.String getConfigPath()
           
 java.lang.String getDefaultDomain()
           
 void getProperties()
           
 java.util.List getServiceUrls()
           
 com.sun.jdmk.comm.HtmlAdaptorServer html(java.lang.String url)
           
 javax.management.remote.JMXConnectorServer jmxmp(java.lang.String url)
          Creates a JMXMP Connector Server, starts it, and registers it in the LDAP directory.
static void main(java.lang.String[] args)
           
 javax.management.remote.JMXConnectorServer rmi(java.lang.String url)
          Creates an RMI Connector Server, starts it, and registers it with the LDAP directory.
 void start()
           
 void start(javax.management.remote.JMXConnectorServer server, java.util.Map env, java.lang.String agentName)
          Start a JMXConnectorServer and register it with the LDAP directory.
 void startEngine()
           
 void startMailServer()
           
 void stop()
           
 void stop(javax.management.remote.JMXConnectorServer server, java.util.Map env, java.lang.String agentName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

loggerName

public static final java.lang.String loggerName

CONFIG_PATH_SYSPROP

public static final java.lang.String CONFIG_PATH_SYSPROP

CONFIG_FILE_NAME

protected static java.lang.String CONFIG_FILE_NAME

RMI_CONNECTOR_URL

public static final java.lang.String RMI_CONNECTOR_URL

JMXMP_CONNECTOR_URL

public static final java.lang.String JMXMP_CONNECTOR_URL

HTML_ADAPTOR_URL

public static final java.lang.String HTML_ADAPTOR_URL

MAILSERVER_NAME

public static final java.lang.String MAILSERVER_NAME

ENGINE_NAME

public static final java.lang.String ENGINE_NAME
Constructor Detail

CollaborationManagementAgent

public CollaborationManagementAgent()
                             throws java.io.IOException
Method Detail

create

public void create()
            throws java.io.IOException
Attach connectors & adaptors to the MBean Server then start them. Attach and start Collaboration service mBeans.
Throws:
java.io.IOException -  

getConfigPath

protected java.lang.String getConfigPath()

getConfigFileStream

protected java.io.InputStream getConfigFileStream()

getProperties

public void getProperties()
                   throws java.io.IOException

getDefaultDomain

public java.lang.String getDefaultDomain()

createMBean

public javax.management.ObjectInstance createMBean(java.lang.String className,
                                                   javax.management.ObjectName objectName,
                                                   javax.management.ObjectName classLoaderName,
                                                   java.lang.Object[] params,
                                                   java.lang.String[] signature)
                                            throws javax.management.JMException

rmi

public javax.management.remote.JMXConnectorServer rmi(java.lang.String url)
                                               throws java.io.IOException,
                                                      javax.management.JMException,
                                                      java.lang.ClassNotFoundException,
                                                      java.lang.IllegalArgumentException
Creates an RMI Connector Server, starts it, and registers it with the LDAP directory.

This method will transfer a fixed set of System Properties to the Map given to the RMIConnectorServer constructor. Some JNDI properties, if defined, are transfered to the Map so that they may be used when LDAP is used as external directory to register the RMI Stub (see javax.management.remote.rmi Javadoc). Note that even if LDAP is used as external directory the Context.INITIAL_CONTEXT_FACTORY and Context.PROVIDER_URL properties usually don't need to be passed.

The following System properties, if defined, are transfered to the Map given to the RMIConnectorServer constructor.

Parameters:
url - A string representation of the JMXServiceURL.
Returns:
the created RMIConnectorServer.

jmxmp

public javax.management.remote.JMXConnectorServer jmxmp(java.lang.String url)
                                                 throws java.io.IOException,
                                                        javax.management.JMException,
                                                        java.lang.ClassNotFoundException,
                                                        java.lang.IllegalArgumentException
Creates a JMXMP Connector Server, starts it, and registers it in the LDAP directory.
Parameters:
url - A string representation of the JMXServiceURL.
Returns:
the created JMXMPConnectorServer.

html

public com.sun.jdmk.comm.HtmlAdaptorServer html(java.lang.String url)
                                         throws javax.management.MalformedObjectNameException,
                                                javax.management.NotCompliantMBeanException,
                                                javax.management.MBeanRegistrationException,
                                                javax.management.InstanceAlreadyExistsException,
                                                java.net.MalformedURLException

getServiceUrls

public java.util.List getServiceUrls()

start

public void start(javax.management.remote.JMXConnectorServer server,
                  java.util.Map env,
                  java.lang.String agentName)
           throws java.io.IOException
Start a JMXConnectorServer and register it with the LDAP directory. //@TODO
Parameters:
server - the JMXConnectorServer to start and register.
env - the environment Map.
agentName - the AgentName with which the URL must be registered in the LDAP Directory. This is not a LDAP DN, but the value of the jmxAgentName attribute.

stop

public void stop(javax.management.remote.JMXConnectorServer server,
                 java.util.Map env,
                 java.lang.String agentName)
          throws java.io.IOException

start

public void start()
           throws javax.management.JMException,
                  java.io.IOException

stop

public void stop()

startEngine

public void startEngine()
                 throws javax.management.JMException,
                        java.io.IOException

startMailServer

public void startMailServer()
                     throws javax.management.JMException,
                            java.io.IOException

configMailServer

public boolean configMailServer()
                         throws javax.management.JMException,
                                java.io.IOException

getAgent

public static CollaborationManagementAgent getAgent()

findServer

public static javax.management.MBeanServerConnection findServer()
Find the running instance of our JMX Server
Returns:
 

main

public static final void main(java.lang.String[] args)

Collaboration API Documentation

Copyright ?2002 - 2005 FileNet Corporation. All rights reserved.