com.tibco.as.space

Class ASCommon

java.lang.Object

com.tibco.as.space.ASCommon

public class ASCommon
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ASCommon()

Method Summary

Modifier and Type	Method and Description
static Metaspace	connectMetaspace(java.lang.String name, MemberDef memberDef)
static Metaspace	connectMetaspace(java.lang.String name, MemberDef memberDef, LocalSiteDef localSiteDef)
static java.util.Map<java.lang.String,java.lang.Object>	getInvocableAliases()
static LogLevel	getLogLevel() Returns log level.
static java.util.Map<java.lang.String,java.lang.Object>	getMemberInvocableAliases()
static Metaspace	getMetaspace(java.lang.String metaspaceName)
static java.util.Collection<java.lang.String>	getMetaspaceNames() Returns the collection of names of the metaspace the process is currently connected to
static LogLevel	getSecurityLogLevel()
static boolean	isEnablePerformanceMonitor() Check the status of the performance monitor.
static boolean	removeInvocableAlias(java.lang.String alias) Remove alias from invocation mapping
static boolean	removeMemberInvocableAlias(java.lang.String alias) Remove alias from invocation mapping
static void	setEnablePerformanceMonitor(boolean isEnabled) Enable or disable the performance monitor.
static void	setEventLogging(java.io.File logDir, java.lang.String filename, LogLevel level)
static void	setEventLogging(java.lang.String filename, LogLevel level)
static void	setFileLogging(FileLogOptions options)
static void	setFileLogging(java.io.File logDir, java.lang.String filename, LogLevel level) Deprecated. Use setFileLogging(FileLogOptions)
static void	setFileLogging(LogLevel level) Deprecated. Use setFileLogging(FileLogOptions)
static void	setFileLogging(java.lang.String filename, LogLevel level) Deprecated. Use setFileLogging(FileLogOptions)
static void	setFileLogging(java.lang.String logDir, java.lang.String filename, LogLevel level) Deprecated. Use setFileLogging(FileLogOptions)
static void	setInvocableAlias(java.lang.String alias, Invocable invocable) Sets the invocable object instance to be used for invocations on this alias name.
static void	setInvocableAlias(java.lang.String alias, java.lang.String classname) Add alias to invocables
static void	setLogLevel(LogLevel level) Sets the log level.
static void	setMemberInvocableAlias(java.lang.String alias, MemberInvocable memberInvocable) Sets the member invocable instance to be used for member invocations on this alias name.
static void	setMemberInvocableAlias(java.lang.String alias, java.lang.String classname) Add alias to member invocables
static void	setSecurityLogLevel(LogLevel level)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ASCommon

public ASCommon()

Method Detail

setLogLevel

public static void setLogLevel(LogLevel level)

Sets the log level. Log level is defined to be LogLevel

Parameters:

level - Log level

setSecurityLogLevel

public static void setSecurityLogLevel(LogLevel level)

getLogLevel

public static LogLevel getLogLevel()

Returns log level. Log level is defined to be LogLevel

Returns:

LogLevel The log level

setEnablePerformanceMonitor

public static void setEnablePerformanceMonitor(boolean isEnabled)

Enable or disable the performance monitor. The default is disabled. It must be used before connecting to the first metaspace. Once a metaspace is created, the method has no effect.

Parameters:

isEnabled - The preferred status of the performance monitor

isEnablePerformanceMonitor

public static boolean isEnablePerformanceMonitor()

Check the status of the performance monitor.

Returns:

The status of the performance monitor.

getSecurityLogLevel

public static LogLevel getSecurityLogLevel()

setFileLogging

@Deprecated
public static void setFileLogging(LogLevel level)

Deprecated. Use setFileLogging(FileLogOptions)

Enabled file logging to default file name (as-<processId>.log)

Parameters:

level - Log level

setFileLogging

@Deprecated
public static void setFileLogging(java.lang.String filename,
                                              LogLevel level)

Deprecated. Use setFileLogging(FileLogOptions)

Enables file logging to specified file name

Parameters:

filename - Filename under log directory

level - Log level

setFileLogging

@Deprecated
public static void setFileLogging(java.lang.String logDir,
                                              java.lang.String filename,
                                              LogLevel level)

Deprecated. Use setFileLogging(FileLogOptions)

Enables file logging to specified file name under specified log directory path

Parameters:

logDir - Log directory

filename - Log file name

level - Log level

setFileLogging

public static void setFileLogging(java.io.File logDir,
                                  java.lang.String filename,
                                  LogLevel level)

Deprecated. Use setFileLogging(FileLogOptions)

Enables file logging to specified file name under specified log directory path

Parameters:

logDir - Log directory

filename - Log file name

level - Log level

setFileLogging

public static void setFileLogging(FileLogOptions options)

setEventLogging

public static void setEventLogging(java.lang.String filename,
                                   LogLevel level)

setEventLogging

public static void setEventLogging(java.io.File logDir,
                                   java.lang.String filename,
                                   LogLevel level)

getMetaspace

public static Metaspace getMetaspace(java.lang.String metaspaceName)

Parameters:

metaspaceName - Metaspace name to get

Returns:

returns the metaspace object if the process is already connected to a metaspace with that name

connectMetaspace

public static Metaspace connectMetaspace(java.lang.String name,
                                         MemberDef memberDef)
                                  throws ASException

Throws:

ASException

connectMetaspace

public static Metaspace connectMetaspace(java.lang.String name,
                                         MemberDef memberDef,
                                         LocalSiteDef localSiteDef)
                                  throws ASException

Throws:

ASException

getMetaspaceNames

public static java.util.Collection<java.lang.String> getMetaspaceNames()

Returns the collection of names of the metaspace the process is currently connected to

Returns:

Collection of metaspace names

setInvocableAlias

public static void setInvocableAlias(java.lang.String alias,
                                     java.lang.String classname)
                              throws ASException

Add alias to invocables

Parameters:

alias - Alias name

classname - Invocable class name

Throws:

ASException

setMemberInvocableAlias

public static void setMemberInvocableAlias(java.lang.String alias,
                                           java.lang.String classname)
                                    throws ASException

Add alias to member invocables

Parameters:

alias - Alias name

classname - MemberInvocable class name

Throws:

ASException

setInvocableAlias

public static void setInvocableAlias(java.lang.String alias,
                                     Invocable invocable)

Sets the invocable object instance to be used for invocations on this alias name. For each invoke, same object instance will be used

Parameters:

alias - Alias name

invocable - Invocable class intance

setMemberInvocableAlias

public static void setMemberInvocableAlias(java.lang.String alias,
                                           MemberInvocable memberInvocable)

Sets the member invocable instance to be used for member invocations on this alias name. For each member invoke, memberInvocable instance will be used

Parameters:

alias - Alias name

memberInvocable - MemberInvocable class instance

getInvocableAliases

public static java.util.Map<java.lang.String,java.lang.Object> getInvocableAliases()

getMemberInvocableAliases

public static java.util.Map<java.lang.String,java.lang.Object> getMemberInvocableAliases()

removeInvocableAlias

public static boolean removeInvocableAlias(java.lang.String alias)

Remove alias from invocation mapping

Parameters:

alias - Alias name to Invocable

removeMemberInvocableAlias

public static boolean removeMemberInvocableAlias(java.lang.String alias)

Remove alias from invocation mapping

Parameters:

alias - Alias name to MemberInvocable

Returns:

String classname