IfsProtocolServer (ecmsdk-api 3.4.0 API)

java.lang.Object
- oracle.ifs.core.runtime.Server
- - oracle.ifs.core.runtime.IfsServer
  - - oracle.ifs.protocols.utils.IfsProtocolServer

All Implemented Interfaces:

ServerInterface, TimerContext

Direct Known Subclasses:

CommandlineUtilityServer
```
public abstract class IfsProtocolServer
extends IfsServer
```
An IfsProtocolServer is an abstract protocol server, that represents part of the protocol framework tool kit for building iFS protocol servers.

Version:

1.0

Author:

Dave Long, Kevin Gillett

(Published)

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`	`LOCALE_COUNTRY` Locale Country
`static String`	`LOCALE_LANGUAGE` Locale Language
`static String`	`LOCALE_VARIANT` Locale Variant
`static String`	`LOCALHOST_DEFAULT`
`protected int`	`m_AcceptQueueSize`
`protected boolean`	`m_AnonymousAllowed`
`protected String`	`m_AnonymousName`
`protected Stack`	`m_AnonymousPool` anonymous session pool
`protected int`	`m_AnonymousPoolsize`
`protected InetAddress`	`m_BindAddress`
`protected Hashtable`	`m_Channels` Session table; hashed by channel sequnece.
`protected int`	`m_ChannelSequence` Channel sequence number
`protected CommandInvoker`	`m_Commands` Command table
`protected int`	`m_ControlPort`
`protected ServerSocket`	`m_ControlSocketServer` The control ServerSocket object.
`protected String`	`m_DateFormat`
`protected String`	`m_Delimiter`
`protected String`	`m_HostAddress`
`protected String`	`m_HostName`
`protected long`	`m_LastStaleSessionRemoval`
`protected Locale`	`m_Locale`
`protected String`	`m_LocaleCountry`
`protected String`	`m_LocaleLanguage`
`protected String`	`m_LocaleVariant`
`protected String`	`m_Localhost`
`protected Localizer`	`m_Localizer` the localizer for the Strings
`protected Hashtable`	`m_ProtocolSessions` Hastable of active sessions; hashed by server produced cookie.
`protected Random`	`m_Random` Random number genertor for psession "cookies"
`protected long`	`m_SessionStateTimeoutPeriod`
`protected int`	`m_SessionTimeoutPeriod`
`protected long`	`m_StaleSessionRemovalPeriod`
`protected String`	`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.core.runtime.ServerInterface
SERVERSTATUS_DISPOSED, SERVERSTATUS_RUNNING, SERVERSTATUS_STARTING, SERVERSTATUS_STOPPED, SERVERSTATUS_STOPPING, SERVERSTATUS_SUSPENDED, SERVERSTATUS_UNKNOWN

Constructor Summary

Constructors
Constructor and Description

IfsProtocolServer()
Construct an IfsProtocolServer.

Constructors
Constructor and Description
`IfsProtocolServer()` Construct an IfsProtocolServer.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`addNewProtocolSession(IfsProtocolSession psession)` Adds a new ProtocolSession to the server.
`protected void`	`clearDerivedProperties()`
`protected void`	`closeSocketServer()` If we have no socket port open we do it here.
`protected abstract IfsServerChannel`	`constructChannel(Socket socket, int channelKey, String threadName)` Construct an IfsServerChannel.
`void`	`dispose()` Disposes this Server.
`protected void`	`establishServerSocket(LibrarySession session)` If we have no socket port open we do it here.
`protected abstract String`	`getAcceptQueueSizeKey()`
`boolean`	`getAnonymousAllowed()`
`protected abstract String`	`getAnonymousAllowedKey()`
`protected abstract String`	`getAnonymousPoolsizeKey()`
`protected abstract String`	`getAnonymousPoolSizeKey()`
`LibrarySession`	`getAnonymousSession()` Gets an anonymous session.
`String`	`getAnonymousUserName(LibrarySession session)` Gets the name for the anonymous user from a domain propoerty.
`InetAddress`	`getBindAddress()` Get Server's InetAddrees on which it is listening.
`CommandInvoker`	`getCommandInvoker()` Gets the CommandInvoker of the protocol.
`int`	`getControlPort()` Get Server's control port on which it is listening.
`protected abstract String`	`getDateFormatKey()`
`String`	`getDateFormatProperty()`
`abstract int`	`getDefaultPort()` Get Server's default port.
`protected abstract String`	`getDelimiterKey()`
`String`	`getDelimiterProperty()`
`abstract String`	`getDescriptiveName()` Get Server's descriptive name.
`protected abstract String`	`getHostAddressKey()`
`String`	`getHostname()` Get Server's Hostname on which it is listening.
`protected abstract String`	`getHostNameKey()`
`protected abstract String`	`getLastStaleSessionRemovalPeriodKey()`
`protected abstract String`	`getLibraryVersionKey()`
`Locale`	`getLocale()` Returns the locale of the protocol server.
`protected abstract String`	`getLocalhostKey()`
`protected abstract String`	`getPortKey()`
`IfsProtocolSession`	`getProtocolSession(Object cookie)` Gets a ProtocolSession from the server.
`String`	`getResourceString(String key)`
`String`	`getResourceString(String key, Object[] inserts)`
`protected ServerSocket`	`getServerSocket()` Gets the ServerSocket used by this server for the main listener.
`protected abstract String`	`getSessionStateTimeoutKey()`
`protected abstract String`	`getSessionTimeoutKey()`
`int`	`getSessionTimeoutPeriodProperty()`
`protected abstract String`	`getStaleSessionRemovalPeriodKey()`
`protected void`	`handlePropertyChangeRequest(AttributeValue av)` Called when a dynamic property of this Server is set or changed.
`protected void`	`handlePropertyChangeRequest(LibrarySession session, String name, AttributeValue av)`
`protected void`	`handleStopRequest()` Called when this Server is requested to stop.
`void`	`initialize()` Initializes this Server.
`boolean`	`isPropertyReadonly(String name)` Gets whether the specified dynamic property is readonly.
`protected void`	`postAcceptLoop()` This is called after the server accept loop.
`protected void`	`postRun()` The post-run tasks for this Server.
`protected void`	`preAcceptLoop()` This is called prior to the server accept loop.
`protected void`	`preRun()` The pre-run tasks for this Server.
`protected void`	`registerCommand(Object key, Command cmd, ArgumentTranslator argTrans, ResultTranslator resultTrans)` Conviencve method for registers a Command.
`protected void`	`registerCommand(Object key, String cmdName)` Conviencve method for registers a Command which is an ArgumentTranslator and a ResultTranslator.
`protected void`	`registerCommand(Object key, String cmdName, ArgumentTranslator argTrans, ResultTranslator resultTrans)` Conviencve method for registers a Command.
`protected abstract void`	`registerCommands(LibrarySession session)` Register the Commands that this Server invokes.
`void`	`releaseAnonymousSession(LibrarySession sess)` Releases an anonymous session.
`void`	`removeChannel(int channelSequence)` Record that a Channel is no longer active.
`void`	`removeProtocolSession(IfsProtocolSession psession)` Removes a ProtocolSession from the server.
`protected void`	`run()` The run tasks for this Server.
`protected boolean`	`shouldHandlePropertyRequest(String name)`
`void`	`shutdown()`
`boolean`	`supportsPriority()` Gets whether this Server supports set/get priority.
`boolean`	`supportsSuspendResume()` Gets whether this Server supports suspend/resume.
`protected void`	`useInitializationSession(LibrarySession session)`

Methods inherited from class oracle.ifs.core.runtime.IfsServer
checkSession, connectSession, constructSession, convertTimerInterval, convertTimerInterval, convertTimerInterval, getLastTimerActivation, getLogger, 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, getLoggerForLegacyLogging, 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
  - LOCALHOST_DEFAULT
```
public static final String LOCALHOST_DEFAULT
```
    See Also:
    
    Constant Field Values
  - LOCALE_LANGUAGE
```
public static final String LOCALE_LANGUAGE
```
    Locale Language
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - LOCALE_COUNTRY
```
public static final String LOCALE_COUNTRY
```
    Locale Country
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - LOCALE_VARIANT
```
public static final String LOCALE_VARIANT
```
    Locale Variant
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - m_Version
```
protected String m_Version
```
  - m_AnonymousAllowed
```
protected boolean m_AnonymousAllowed
```
  - m_AnonymousPoolsize
```
protected int m_AnonymousPoolsize
```
  - m_AnonymousName
```
protected String m_AnonymousName
```
  - m_Localhost
```
protected String m_Localhost
```
  - m_HostName
```
protected String m_HostName
```
  - m_HostAddress
```
protected String m_HostAddress
```
  - m_BindAddress
```
protected InetAddress m_BindAddress
```
  - m_LocaleLanguage
```
protected String m_LocaleLanguage
```
  - m_LocaleCountry
```
protected String m_LocaleCountry
```
  - m_LocaleVariant
```
protected String m_LocaleVariant
```
  - m_Locale
```
protected Locale m_Locale
```
  - m_ControlPort
```
protected int m_ControlPort
```
  - m_AcceptQueueSize
```
protected int m_AcceptQueueSize
```
  - m_Delimiter
```
protected String m_Delimiter
```
  - m_DateFormat
```
protected String m_DateFormat
```
  - m_SessionTimeoutPeriod
```
protected int m_SessionTimeoutPeriod
```
  - m_SessionStateTimeoutPeriod
```
protected long m_SessionStateTimeoutPeriod
```
  - m_StaleSessionRemovalPeriod
```
protected long m_StaleSessionRemovalPeriod
```
  - m_LastStaleSessionRemoval
```
protected long m_LastStaleSessionRemoval
```
  - m_Localizer
```
protected Localizer m_Localizer
```
    the localizer for the Strings
    
    (Unpublished)
  - m_ChannelSequence
```
protected int m_ChannelSequence
```
    Channel sequence number
    
    (Unpublished)
  - m_Channels
```
protected Hashtable m_Channels
```
    Session table; hashed by channel sequnece.
    
    (Published)
  - m_ProtocolSessions
```
protected Hashtable m_ProtocolSessions
```
    Hastable of active sessions; hashed by server produced cookie.
    
    (Published)
  - m_Commands
```
protected CommandInvoker m_Commands
```
    Command table
    
    (Published)
  - m_Random
```
protected Random m_Random
```
    Random number genertor for psession "cookies"
    
    (Unpublished)
  - m_AnonymousPool
```
protected Stack m_AnonymousPool
```
    anonymous session pool
    
    (Unpublished)
  - m_ControlSocketServer
```
protected ServerSocket m_ControlSocketServer
```
    The control ServerSocket object. Here we listen for incoming requests from this server's clients.
    
    (Published)
- Constructor Detail
  - IfsProtocolServer
```
public IfsProtocolServer()
                  throws Exception
```
    Construct an IfsProtocolServer.
    
    Throws:
    
    Exception
    
    (Unpublished)
- Method Detail
  - 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 IfsServer
    
    Throws:
    
    Exception - if the operation fails
    
    (Published)
  - dispose
```
public void dispose()
             throws IfsException
```
    Disposes this Server.
    This deregisters the Server to unload it from the iFS node. The Server must already be stopped.
    Subclasses that override this method should call super.dispose() unless they intend to veto the dispose request.
    
    Specified by:
    
    dispose in interface ServerInterface
    
    Overrides:
    
    dispose in class IfsServer
    
    Throws:
    
    IfsException - (IFS-45169) if the operation fails
    
    (Published)
  - useInitializationSession
```
protected void useInitializationSession(LibrarySession session)
                                 throws Exception
```
    Throws:
    
    Exception
  - supportsSuspendResume
```
public boolean supportsSuspendResume()
```
    Description copied from class: Server
    
    Gets whether this Server supports suspend/resume.
    If false, then suspend and resume will result in stop and start instead.
    
    Specified by:
    
    supportsSuspendResume in interface ServerInterface
    
    Overrides:
    
    supportsSuspendResume in class Server
    
    Returns:
    
    false; subclasses may override
  - supportsPriority
```
public boolean supportsPriority()
```
    Description copied from class: Server
    
    Gets whether this Server supports set/get priority.
    If false, then setPriority and getPriority will throw an exception.
    
    Specified by:
    
    supportsPriority in interface ServerInterface
    
    Overrides:
    
    supportsPriority in class Server
    
    Returns:
    
    true; to disable set/get priority, override this method
  - 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 IfsServer
    
    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
  - preRun
```
protected void preRun()
               throws Exception
```
    Description copied from class: IfsServer
    
    The pre-run tasks for this Server.
    This method is invoked each time this Server is started. Unless overridden, no operation is performed by this method. The Server status is SERVERSTATUS_STARTING while this method executes. When this method returns, the status changes to SERVERSTATUS_RUNNING and run is invoked. However, if this method throws, the status is set to SERVERSTATUS_STOPPING and postRun is invoked.
    
    Overrides:
    
    preRun in class IfsServer
    
    Throws:
    
    Exception - if the operation fails
  - preAcceptLoop
```
protected void preAcceptLoop()
                      throws IfsException
```
    This is called prior to the server accept loop.
    
    Throws:
    
    if - the operation fails
    
    IfsException
    
    (Published)
  - postAcceptLoop
```
protected void postAcceptLoop()
                       throws IfsException
```
    This is called after the server accept loop.
    
    Throws:
    
    if - the operation fails
    
    IfsException
    
    (Published)
  - run
```
protected void run()
```
    Description copied from class: IfsServer
    The run tasks for this Server.
    Override this method with tasks to be performed by this Server. This method is called after preRun each time this Server is started. The server status is SERVERSTATUS_RUNNING while this method executes. When this method terminates (by returning or throwing), the status is set to SERVERSTATUS_STOPPING and postRun is invoked.
    The run method should provide a loop to dispatch requests and events. The canonical form of this loop is:
```
 try
 {
   while (!stopRequested())
   {
     try
     {
       handleRequests();
         
       if (stopRequested())
       {
         break;
       }
         
       processEvents();
       waitServer();
     }
     catch (Throwable t)
     {
       s_Logger.log(Level.WARNING, "Exception in dispatch loop", t);
     }
   }
   catch (Throwable t)
   {
     s_Logger.log(Level.WARNING, "Run failed", t);
   }
 }
 
```
    Specified by:
    
    run in class IfsServer
  - postRun
```
protected void postRun()
```
    Description copied from class: IfsServer
    
    The post-run tasks for this Server.
    This method is invoked each time this Server is stopped, whether by the run method returning or either the preRun or run methods throwing. Unless overridden, no operation is performed by this method. While this method executes, the server status is SERVERSTATUS_STOPPING. When this method terminates (by either returning or throwing), the status of the server is set to SERVERSTATUS_STOPPED.
    
    Overrides:
    
    postRun in class IfsServer
  - clearDerivedProperties
```
protected void clearDerivedProperties()
                               throws Exception
```
    Throws:
    
    Exception
  - shutdown
```
public void shutdown()
              throws Exception
```
    Throws:
    
    Exception
  - shouldHandlePropertyRequest
```
protected boolean shouldHandlePropertyRequest(String name)
```
  - handlePropertyChangeRequest
```
protected final void handlePropertyChangeRequest(AttributeValue av)
                                          throws Exception
```
    Description copied from class: IfsServer
    
    Called when a dynamic property of this Server is set or changed.
    This method is called by handleRequests. Override it to perform tasks when a dynamic property is set or changed. If not overridden, this method simply causes the requested property to be changed.
    The handleRequests method will rethrow any exception thrown by this method.
    A Server may also call this method to set the value of a dynamic property. Unlike calling setProperty, calling this method sets the property's value synchronously, and also allows the value of a readonly property to be set.
    
    Overrides:
    
    handlePropertyChangeRequest in class IfsServer
    
    Parameters:
    
    av - the property (name and value assumed to be set)
    
    Throws:
    
    Exception - if the operation fails
  - handlePropertyChangeRequest
```
protected void handlePropertyChangeRequest(LibrarySession session,
                                           String name,
                                           AttributeValue av)
                                    throws Exception
```
    Throws:
    
    Exception
  - getAnonymousAllowed
```
public boolean getAnonymousAllowed()
```
  - getSessionTimeoutPeriodProperty
```
public int getSessionTimeoutPeriodProperty()
```
  - getDelimiterProperty
```
public String getDelimiterProperty()
```
  - getDateFormatProperty
```
public String getDateFormatProperty()
```
  - handleStopRequest
```
protected void handleStopRequest()
                          throws Exception
```
    Description copied from class: IfsServer
    
    Called when this Server is requested to stop.
    This method is called by handleRequests. Override it to perform tasks upon a request to stop. If not overridden, this method simply causes subsequent calls to stopRequested to return true.
    The handleRequests method will rethrow any exception thrown by this method.
    
    Overrides:
    
    handleStopRequest in class IfsServer
    
    Throws:
    
    Exception - if the operation fails
  - getServerSocket
```
protected ServerSocket getServerSocket()
                                throws IOException
```
    Gets the ServerSocket used by this server for the main listener.
    
    Returns:
    
    the server's ServerSocket
    
    Throws:
    
    IOException
    
    (Unpublished)
  - establishServerSocket
```
protected void establishServerSocket(LibrarySession session)
                              throws Exception
```
    If we have no socket port open we do it here.
    
    Throws:
    
    Exception
    
    (Unpublished)
  - closeSocketServer
```
protected void closeSocketServer()
                          throws IOException
```
    If we have no socket port open we do it here.
    
    Throws:
    
    IOException
    
    (Unpublished)
  - registerCommands
```
protected abstract 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)
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getCommandInvoker
```
public CommandInvoker getCommandInvoker()
```
    Gets the CommandInvoker of the protocol.
    
    (Published)
  - registerCommand
```
protected void registerCommand(Object key,
                               String cmdName,
                               ArgumentTranslator argTrans,
                               ResultTranslator resultTrans)
                        throws IfsException
```
    Conviencve method for registers a Command.
    
    Throws:
    
    IfsException
    
    (Published)
  - registerCommand
```
protected void registerCommand(Object key,
                               String cmdName)
                        throws IfsException
```
    Conviencve method for registers a Command which is an ArgumentTranslator and a ResultTranslator.
    
    Throws:
    
    IfsException
    
    (Published)
  - registerCommand
```
protected void registerCommand(Object key,
                               Command cmd,
                               ArgumentTranslator argTrans,
                               ResultTranslator resultTrans)
                        throws IfsException
```
    Conviencve method for registers a Command.
    
    Throws:
    
    IfsException
    
    (Published)
  - getDescriptiveName
```
public abstract String getDescriptiveName()
                                   throws IfsException
```
    Get Server's descriptive name.
    
    Returns:
    
    the server's descriptive name.
    
    Throws:
    
    IfsException
    
    (Published)
  - getDefaultPort
```
public abstract int getDefaultPort()
                            throws IfsException
```
    Get Server's default port.
    
    Returns:
    
    the server's default port.
    
    Throws:
    
    IfsException
    
    (Published)
  - constructChannel
```
protected abstract IfsServerChannel constructChannel(Socket socket,
                                                     int channelKey,
                                                     String threadName)
                                              throws Exception
```
    Construct an IfsServerChannel. This abstract class is overridden to construct the desired implmentation of the protocol session.
    
    Throws:
    
    IfsException - if the operation fails
    
    Exception
    
    (Published)
  - getPortKey
```
protected abstract String getPortKey()
```
  - getDelimiterKey
```
protected abstract String getDelimiterKey()
```
  - getDateFormatKey
```
protected abstract String getDateFormatKey()
```
  - getAnonymousAllowedKey
```
protected abstract String getAnonymousAllowedKey()
```
  - getLibraryVersionKey
```
protected abstract String getLibraryVersionKey()
```
  - getAnonymousPoolSizeKey
```
protected abstract String getAnonymousPoolSizeKey()
```
  - getSessionTimeoutKey
```
protected abstract String getSessionTimeoutKey()
```
  - getSessionStateTimeoutKey
```
protected abstract String getSessionStateTimeoutKey()
```
  - getStaleSessionRemovalPeriodKey
```
protected abstract String getStaleSessionRemovalPeriodKey()
```
  - getAcceptQueueSizeKey
```
protected abstract String getAcceptQueueSizeKey()
```
  - getLocalhostKey
```
protected abstract String getLocalhostKey()
```
  - getLastStaleSessionRemovalPeriodKey
```
protected abstract String getLastStaleSessionRemovalPeriodKey()
```
  - getHostNameKey
```
protected abstract String getHostNameKey()
```
  - getHostAddressKey
```
protected abstract String getHostAddressKey()
```
  - getAnonymousPoolsizeKey
```
protected abstract String getAnonymousPoolsizeKey()
```
  - getBindAddress
```
public InetAddress getBindAddress()
                           throws IfsException
```
    Get Server's InetAddrees on which it is listening.
    
    Returns:
    
    the server's bind InetAddrees.
    
    Throws:
    
    IfsException
    
    (Published)
  - getHostname
```
public String getHostname()
                   throws IfsException
```
    Get Server's Hostname on which it is listening.
    
    Returns:
    
    the server's Hostname.
    
    Throws:
    
    IfsException
    
    (Published)
  - getControlPort
```
public int getControlPort()
                   throws IfsException
```
    Get Server's control port on which it is listening.
    
    Returns:
    
    the server's contorl port.
    
    Throws:
    
    IfsException
    
    (Published)
  - removeChannel
```
public void removeChannel(int channelSequence)
```
    Record that a Channel is no longer active. IfsProtocolSession removal is a seperate task.
    
    Parameters:
    
    channelSequence - the channel
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Published)
  - addNewProtocolSession
```
public Object addNewProtocolSession(IfsProtocolSession psession)
                             throws IfsException
```
    Adds a new ProtocolSession to the server.
    
    Returns:
    
    Object the cookie
    
    Throws:
    
    IfsException
    
    (Published)
  - removeProtocolSession
```
public void removeProtocolSession(IfsProtocolSession psession)
```
    Removes a ProtocolSession from the server.
    
    (Published)
  - getProtocolSession
```
public IfsProtocolSession getProtocolSession(Object cookie)
                                      throws Exception
```
    Gets a ProtocolSession from the server.
    
    Throws:
    
    Exception
    
    (Published)
  - getAnonymousUserName
```
public String getAnonymousUserName(LibrarySession session)
                            throws IfsException
```
    Gets the name for the anonymous user from a domain propoerty.
    
    Throws:
    
    IfsException
    
    (Published)
  - getAnonymousSession
```
public LibrarySession getAnonymousSession()
                                   throws IfsException
```
    Gets an anonymous session.
    
    Throws:
    
    IfsException
    
    (Published)
  - releaseAnonymousSession
```
public void releaseAnonymousSession(LibrarySession sess)
                             throws IfsException
```
    Releases an anonymous session.
    
    Throws:
    
    IfsException
    
    (Published)
  - getLocale
```
public Locale getLocale()
                 throws IfsException
```
    Returns the locale of the protocol server.
    
    Throws:
    
    IfsException
    
    (Unpublished)
  - getResourceString
```
public String getResourceString(String key)
                         throws IfsException
```
    Throws:
    
    IfsException
  - getResourceString
```
public String getResourceString(String key,
                                Object[] inserts)
                         throws IfsException
```
    Throws:
    
    IfsException

Class IfsProtocolServer

Nested Class Summary

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

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

LOCALHOST_DEFAULT

LOCALE_LANGUAGE

LOCALE_COUNTRY

LOCALE_VARIANT

m_Version

m_AnonymousAllowed

m_AnonymousPoolsize

m_AnonymousName

m_Localhost

m_HostName

m_HostAddress

m_BindAddress

m_LocaleLanguage

m_LocaleCountry

m_LocaleVariant

m_Locale

m_ControlPort

m_AcceptQueueSize

m_Delimiter

m_DateFormat

m_SessionTimeoutPeriod

m_SessionStateTimeoutPeriod

m_StaleSessionRemovalPeriod

m_LastStaleSessionRemoval

m_Localizer

m_ChannelSequence

m_Channels

m_ProtocolSessions

m_Commands

m_Random

m_AnonymousPool

m_ControlSocketServer

Constructor Detail

IfsProtocolServer

Method Detail

initialize

dispose

useInitializationSession

supportsSuspendResume

supportsPriority

isPropertyReadonly

preRun

preAcceptLoop

postAcceptLoop

run

postRun

clearDerivedProperties

shutdown

shouldHandlePropertyRequest

handlePropertyChangeRequest

handlePropertyChangeRequest

getAnonymousAllowed

getSessionTimeoutPeriodProperty

getDelimiterProperty

getDateFormatProperty

handleStopRequest

getServerSocket

establishServerSocket

closeSocketServer

registerCommands

getCommandInvoker

registerCommand

registerCommand

registerCommand

getDescriptiveName

getDefaultPort

constructChannel

getPortKey