oracle.ifs.protocols.cup.server

Class CommandlineUtilityServer

java.lang.Object

oracle.ifs.core.runtime.Server

oracle.ifs.core.runtime.IfsServer

oracle.ifs.protocols.utils.IfsProtocolServer

oracle.ifs.protocols.cup.server.CommandlineUtilityServer

All Implemented Interfaces:

Serializable, ServerInterface, TimerContext, CupConstants

public class CommandlineUtilityServer
extends IfsProtocolServer
implements Serializable, CupConstants

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.core.runtime.IfsServer

IfsServer.ServerRequest

Field Summary

Fields

Modifier and Type	Field and Description
static String	CUP_DESCRIPTIVE_NAME
static String	CUP_NAME
static String	CUP_STATUS
static int	DEFAULT_PORT
protected boolean	m_ObfuscateIds
static String	OBFUSCATE_IDS ObfuscateIds

Fields inherited from class oracle.ifs.protocols.utils.IfsProtocolServer

LOCALE_COUNTRY, LOCALE_LANGUAGE, LOCALE_VARIANT, LOCALHOST_DEFAULT, m_AcceptQueueSize, m_AnonymousAllowed, m_AnonymousName, m_AnonymousPool, m_AnonymousPoolsize, m_BindAddress, m_Channels, m_ChannelSequence, m_Commands, m_ControlPort, m_ControlSocketServer, m_DateFormat, m_Delimiter, m_HostAddress, m_HostName, m_LastStaleSessionRemoval, m_Locale, m_LocaleCountry, m_LocaleLanguage, m_LocaleVariant, m_Localhost, m_Localizer, m_ProtocolSessions, m_Random, m_SessionStateTimeoutPeriod, m_SessionTimeoutPeriod, m_StaleSessionRemovalPeriod, m_Version

Fields inherited from class oracle.ifs.core.runtime.Server

LEVEL_HIGH, LEVEL_LOW, LEVEL_MEDIUM, LEVEL_OFF

Fields inherited from interface oracle.ifs.protocols.cup.server.resources.CupConstants

ACCEPT_QUEUE_SIZE, ANONYMOUS_ALLOWED, ANONYMOUS_POOLSIZE, DATE_FORMAT, DELIMITER, HOST_ADDRESS, HOST_NAME, LAST_STALE_SESSION_REMOVAL_TIME, LIBRARY_VERSION, LOCALHOST, PORT, SESSION_STATE_TIMEOUT_PERIOD, SESSION_TIMEOUT_PERIOD, STALE_SESSION_REMOVAL_PERIOD

Fields inherited from interface oracle.ifs.core.runtime.ServerInterface

SERVERSTATUS_DISPOSED, SERVERSTATUS_RUNNING, SERVERSTATUS_STARTING, SERVERSTATUS_STOPPED, SERVERSTATUS_STOPPING, SERVERSTATUS_SUSPENDED, SERVERSTATUS_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
CommandlineUtilityServer() Default Constructor

Method Summary

Modifier and Type	Method and Description
protected IfsServerChannel	constructChannel(Socket socket, int channelKey, String threadName) Construct an IfsProtocolChannel.
protected String	getAcceptQueueSizeKey()
protected String	getAnonymousAllowedKey()
protected String	getAnonymousPoolsizeKey()
protected String	getAnonymousPoolSizeKey()
protected String	getDateFormatKey()
int	getDefaultPort() get Server's default port.
String	getDefaultServerName() get Server's default name, in case ServerManager doesn't specify one explcitly.
protected String	getDelimiterKey()
String	getDescriptiveName() get Server's descriptive name.
protected String	getHostAddressKey()
protected String	getHostNameKey()
protected String	getLastStaleSessionRemovalPeriodKey()
protected String	getLibraryVersionKey()
protected String	getLocalhostKey()
IfsLogger	getLogger() Gets the appropriate logger for this server.
protected IfsLogger	getLoggerForLegacyLogging() Gets the IfsLogger to use for legacy logging.
boolean	getObfuscateIds() get if the date and ids should be removed from listing commands.
protected String	getPortKey()
protected String	getSessionStateTimeoutKey()
protected String	getSessionTimeoutKey()
protected String	getStaleSessionRemovalPeriodKey()
void	initialize() Initializes this Server.
boolean	isPropertyReadonly(String name) Gets whether the specified dynamic property is readonly.
static void	main(String[] args) This is used to run the CupServer in the standalone mode.
protected void	registerCommands(LibrarySession session) Register the Commands that this Server invokes.
protected void	registerSpecificCommand(String key, String cmd, LibrarySession session)
protected void	useInitializationSession(LibrarySession session) Initialize variables

Methods inherited from class oracle.ifs.protocols.utils.IfsProtocolServer

addNewProtocolSession, clearDerivedProperties, closeSocketServer, dispose, establishServerSocket, getAnonymousAllowed, getAnonymousSession, getAnonymousUserName, getBindAddress, getCommandInvoker, getControlPort, getDateFormatProperty, getDelimiterProperty, getHostname, getLocale, getProtocolSession, getResourceString, getResourceString, getServerSocket, getSessionTimeoutPeriodProperty, handlePropertyChangeRequest, handlePropertyChangeRequest, handleStopRequest, postAcceptLoop, postRun, preAcceptLoop, preRun, registerCommand, registerCommand, registerCommand, releaseAnonymousSession, removeChannel, removeProtocolSession, run, shouldHandlePropertyRequest, shutdown, supportsPriority, supportsSuspendResume

Methods inherited from class oracle.ifs.core.runtime.IfsServer

checkSession, connectSession, constructSession, convertTimerInterval, convertTimerInterval, convertTimerInterval, getLastTimerActivation, getNextTimerActivation, getService, getTimerActivationPeriod, getTimerClassName, getTimerConfiguration, handlePriorityChangeRequest, handlePropertyChangeRequest, handleRequest, handleRequests, handleResumeRequest, handleServerStateControllerRequest, handleSuspendRequest, handleTimerExpired, isNonCompeting, isServiceAvailable, isTimerActive, isTokenNonCompeting, postCheckServerStateRequest, postRequest, processEvent, processEvents, queueEvent, resetTimer, restart, resume, serviceAvailabilityCheckNeeded, setPriority, setProperty, setProperty, start, startTimer, stop, stopRequested, stopTimer, suspend, timerExpired, waitForServiceAvailability, waitServer

Methods inherited from class oracle.ifs.core.runtime.Server

acquireSession, constructLibrarySessionPool, createServerState, deregister, disconnectSession, getConfigurationOverridesTable, getConfigurationTable, getCredential, getDesiredStatus, getIfsHome, getInitialConfigurationTable, getName, getNode, getNodeName, getOracleHome, getParameterTable, getPriority, getProperties, getProperty, getServerConfigurationName, getServerState, getServerStateValue, getServerType, getServiceName, getSession, getStateTable, getStatus, getSystemUserCredential, handleServerConfigurationOverrideRequest, handleServerStateEvent, initialize, initialize, isAgent, isDisposed, isInitialized, isLogged, log, log, log, releaseSession, releaseSession, setDesiredStatus, setDesiredStatus, setSessionTimeoutPrevented, setStateProperty, setStatus, startStandalone, startStandalone, toStatusLabel, toStatusLabel, toStatusLabel, verifyNotDisposed, verifyNotDisposed

Methods inherited from class java.lang.Object

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

Field Detail

OBFUSCATE_IDS

public static final String OBFUSCATE_IDS

ObfuscateIds

See Also:

Constant Field Values

(Unpublished)

CUP_NAME

public static final String CUP_NAME

See Also:

Constant Field Values

CUP_DESCRIPTIVE_NAME

public static final String CUP_DESCRIPTIVE_NAME

See Also:

Constant Field Values

CUP_STATUS

public static final String CUP_STATUS

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

m_ObfuscateIds

protected boolean m_ObfuscateIds

Constructor Detail

CommandlineUtilityServer

public CommandlineUtilityServer()
                         throws Exception

Default Constructor

Throws:

Exception

Method Detail

getLogger

public IfsLogger getLogger()

Gets the appropriate logger for this server.

Typically overridden by subclasses to return the IfsLogger associatged with the specific server.

Overrides:

getLogger in class IfsServer

Returns:

the logger

getDefaultServerName

public String getDefaultServerName()
                            throws IfsException

get Server's default name, in case ServerManager doesn't specify one explcitly.

Returns:

the server's default name.

Throws:

IfsException

(Unpublished)

getDescriptiveName

public String getDescriptiveName()
                          throws IfsException

get Server's descriptive name.

Specified by:

getDescriptiveName in class IfsProtocolServer

Returns:

the server's descriptive name.

Throws:

IfsException

(Unpublished)

getDefaultPort

public int getDefaultPort()
                   throws IfsException

get Server's default port.

Specified by:

getDefaultPort in class IfsProtocolServer

Returns:

the server's default port.

Throws:

IfsException

(Unpublished)

getObfuscateIds

public boolean getObfuscateIds()
                        throws IfsException

get if the date and ids should be removed from listing commands.

Throws:

IfsException

(Unpublished)

constructChannel

protected IfsServerChannel constructChannel(Socket socket,
                                            int channelKey,
                                            String threadName)
                                     throws Exception

Construct an IfsProtocolChannel. This abstract class is overridden to construct the desired implmentation of the protocol session.

Specified by:

constructChannel in class IfsProtocolServer

Throws:

IfsException - if the operation fails

Exception

getPortKey

protected String getPortKey()

Specified by:

getPortKey in class IfsProtocolServer

getDelimiterKey

protected String getDelimiterKey()

Specified by:

getDelimiterKey in class IfsProtocolServer

getDateFormatKey

protected String getDateFormatKey()

Specified by:

getDateFormatKey in class IfsProtocolServer

getAnonymousAllowedKey

protected String getAnonymousAllowedKey()

Specified by:

getAnonymousAllowedKey in class IfsProtocolServer

getLibraryVersionKey

protected String getLibraryVersionKey()

Specified by:

getLibraryVersionKey in class IfsProtocolServer

getAnonymousPoolSizeKey

protected String getAnonymousPoolSizeKey()

Specified by:

getAnonymousPoolSizeKey in class IfsProtocolServer

getSessionTimeoutKey

protected String getSessionTimeoutKey()

Specified by:

getSessionTimeoutKey in class IfsProtocolServer

getSessionStateTimeoutKey

protected String getSessionStateTimeoutKey()

Specified by:

getSessionStateTimeoutKey in class IfsProtocolServer

getStaleSessionRemovalPeriodKey

protected String getStaleSessionRemovalPeriodKey()

Specified by:

getStaleSessionRemovalPeriodKey in class IfsProtocolServer

getAcceptQueueSizeKey

protected String getAcceptQueueSizeKey()

Specified by:

getAcceptQueueSizeKey in class IfsProtocolServer

getLocalhostKey

protected String getLocalhostKey()

Specified by:

getLocalhostKey in class IfsProtocolServer

getLastStaleSessionRemovalPeriodKey

protected String getLastStaleSessionRemovalPeriodKey()

Specified by:

getLastStaleSessionRemovalPeriodKey in class IfsProtocolServer

getHostNameKey

protected String getHostNameKey()

Specified by:

getHostNameKey in class IfsProtocolServer

getHostAddressKey

protected String getHostAddressKey()

Specified by:

getHostAddressKey in class IfsProtocolServer

getAnonymousPoolsizeKey

protected String getAnonymousPoolsizeKey()

Specified by:

getAnonymousPoolsizeKey in class IfsProtocolServer

initialize

public void initialize()
                throws Exception

Initializes this Server.

This method is called when the Server is first loaded.

If this method throws an exception, loading of the Server is aborted.

Overrides:

initialize in class IfsProtocolServer

Throws:

Exception - if the operation fails

(Published)

isPropertyReadonly

public boolean isPropertyReadonly(String name)
                           throws IfsException

Description copied from class: IfsServer

Gets whether the specified dynamic property is readonly.

Readonly properties cannot be set using setProperty.

Specified by:

isPropertyReadonly in interface ServerInterface

Overrides:

isPropertyReadonly in class IfsProtocolServer

Parameters:

name - the property name

Returns:

true; override this method to allow properties to be set using setProperty

Throws:

IfsException - (IFS-45176) if the operation fails

useInitializationSession

protected void useInitializationSession(LibrarySession session)
                                 throws Exception

Initialize variables

Overrides:

useInitializationSession in class IfsProtocolServer

Throws:

Exception

(Published)

registerCommands

protected void registerCommands(LibrarySession session)
                         throws IfsException

Register the Commands that this Server invokes. Register a command via the convience method: protected void registerCommand(Object key, Command command) This method registers all the commands in the def file

Specified by:

registerCommands in class IfsProtocolServer

Throws:

IfsException - if the operation fails

(Published)

registerSpecificCommand

protected void registerSpecificCommand(String key,
                                       String cmd,
                                       LibrarySession session)
                                throws IfsException

Throws:

IfsException

getLoggerForLegacyLogging

protected IfsLogger getLoggerForLegacyLogging()

Gets the IfsLogger to use for legacy logging.

Overrides:

getLoggerForLegacyLogging in class Server

Returns:

the logger to use for legacy logging

main

public static void main(String[] args)
                 throws Exception

This is used to run the CupServer in the standalone mode.

Throws:

Exception