oracle.ifs.protocols.utils

Class ServerUtilities

java.lang.Object

oracle.ifs.protocols.utils.ServerUtilities

public class ServerUtilities
extends Object

Utility methods for protocol servers that need to keep track of each other.

Version:

1.0

Author:

Vijayanth Devadhar

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
ServerUtilities()

Method Summary

Modifier and Type	Method and Description
static void	deregisterPropertyBundle(LibrarySession session, String valueDefaultName, String serverName) Unlocks a server property bundle and frees it.
static PropertyBundle	getPropertyBundle(LibrarySession session, String valueDefaultName, String serverName) Returns the server property bundle for the given server from the value default.
static PropertyBundle[]	getPropertyBundles(LibrarySession session, String valueDefaultName) Returns all active server property bundles in the value default.
static PropertyBundle	registerPropertyBundle(LibrarySession session, String valueDefaultName, String serverName, PropertyBundle serverPropertyBundle) Registers the property bundle for the server and session locks it.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerUtilities

public ServerUtilities()

Method Detail

registerPropertyBundle

public static PropertyBundle registerPropertyBundle(LibrarySession session,
                                                    String valueDefaultName,
                                                    String serverName,
                                                    PropertyBundle serverPropertyBundle)
                                             throws IfsException

Registers the property bundle for the server and session locks it. If a ValueDefault for the passed in name does not exist, then it is created. The server specific property bundle is session locked and returned. If the serverPropertyBundle is null, then a empty property bundle is created and returned. Users need to be system administration mode to call this method if the value default is not already created. If there exists another property bundle with the same name, then that is removed and the new one takes it's place.

Parameters:

session - handle to the LibrarySession

valueDefaultName - name of the ValueDefault

serverName - name of the server trying to register the property bundle.

serverPropertyBundle - server property bundle

Returns:

returns the server property bundle

Throws:

IfsException - if the operation fails

(Published)

deregisterPropertyBundle

public static void deregisterPropertyBundle(LibrarySession session,
                                            String valueDefaultName,
                                            String serverName)
                                     throws IfsException

Unlocks a server property bundle and frees it. No op if there is no property bundle for the given server name. As a side effect cleans up servers that are assumed to be not currently active (no session lock on property bundle).

Parameters:

session - handle to the session

valueDefaultName - name of the valuedefault used to get to the server property bundle

serverName - name of the server whose property bundle needs to be removed

Throws:

IfsException - if the operation fails

(Published)

getPropertyBundle

public static PropertyBundle getPropertyBundle(LibrarySession session,
                                               String valueDefaultName,
                                               String serverName)
                                        throws IfsException

Returns the server property bundle for the given server from the value default. If there is no property bundle for the server, it returns null. If a property bundle exists and is not session locked, this returns a null.

Parameters:

session - handle to Library Session

valueDefaultName - name of the value default

serverName - name of the server

Throws:

IfsException - if the operation fails

(Published)

getPropertyBundles

public static PropertyBundle[] getPropertyBundles(LibrarySession session,
                                                  String valueDefaultName)
                                           throws IfsException

Returns all active server property bundles in the value default. If a server property bundle is session locked, then it is considered active. If a property bundle is not session locked, then that is not included in teh returned array.

Parameters:

session - handle to the LibrarySession

valueDefaultName - name of the valueDefault

Throws:

IfsException - if the operation fails

(Published)