gov.lanl.SSLTools
Interface ServiceInterface

All Known Implementing Classes:

AbstractService

public interface ServiceInterface

Defines the interface for an SSL service which sets up an initializes a specific SSL service.

Method Summary

org.omg.CORBA.Object	enableInsecureForObject(org.omg.CORBA.Object inObj) Enables insecure server connection for this client object
java.applet.Applet	getApplet() Returns the applet object if interface was setup for an applet, else null.
java.util.Properties	getClientData() Get the data identifying the client that is connected to this server associated with the service interface.
java.util.Properties	getClientData(org.omg.CORBA.Object obj) Get the data identifying the client that this object is connected to.
java.security.KeyStore	getKeystore(java.lang.String path) Loads a keystore from a file
java.lang.String	getOptKeyDefault(java.lang.String inKey) Returns the default value for the optional keyword.
java.lang.String[][]	getOptKeysAndValues() Returns the optional keywords and values for a particular implementation.
org.omg.CORBA.ORB	getORB() Returns the ORB created by an instantiated service
java.lang.String[][]	getReqKeysAndValues() Returns the required keywords and possible values for each key for a particular implementation.
java.lang.String	getSecurityLevel() Returns an identifying string for the service's security level.
java.util.Properties	getTargetData() Get the data identifying the target that is connected to this server associated with the service interface.
java.util.Properties	getTargetData(org.omg.CORBA.Object obj) Get the data identifying the target that this object is connected to.
void	init(java.lang.String[] inArgs, java.util.Properties inProps) Initialize the Service
void	printOptKeysAndValues(java.lang.String indent, java.io.PrintStream inPs) Print the optional keywords and their values.
void	printReqKeysAndValues(java.lang.String indent, java.io.PrintStream inPs) Print the required keywords and their values.
void	setApplet(java.applet.Applet inApplet) Set up for an applet
void	setOptKeysAndValues(java.lang.String[][] inKeysAndValues) Remembers the optional keywords and values for a particular implementation
void	setORB(org.omg.CORBA.ORB inOrb) Remembers the ORB
org.omg.CORBA.Object	setQuotedId(org.omg.CORBA.Object inObj, java.util.Properties props) Set the data identifying the client requestor.
org.omg.CORBA.Object	setQuotedId2Me(org.omg.CORBA.Object inObj) Set the quoted data identifying to be a copy of the subjectDN on the wire.
void	setReqKeysAndValues(java.lang.String[][] inKeysAndValues) Remembers the required HashMap of keywords and values for a particular implementation.
void	setSecurityLevel(java.lang.String inSecurityLevel) Remembers an identifying string for the service.

Method Detail

init

public void init(java.lang.String[] inArgs,
                 java.util.Properties inProps)
          throws org.omg.CORBA.UserException

Initialize the Service

org.omg.CORBA.UserException

Parameters:

inArgs - are the command line arguments for -D ORB... usually, these are in the system properties

inProps - are the properties to use, may be null

getORB

public org.omg.CORBA.ORB getORB()

Returns the ORB created by an instantiated service

Returns:

the created ORB

setORB

public void setORB(org.omg.CORBA.ORB inOrb)

Remembers the ORB

Parameters:

inOrb - is the orb to remember

getSecurityLevel

public java.lang.String getSecurityLevel()

Returns an identifying string for the service's security level.

Returns:

the id string

setSecurityLevel

public void setSecurityLevel(java.lang.String inSecurityLevel)

Remembers an identifying string for the service.

Parameters:

inSecurityLevel - is the string to remember

enableInsecureForObject

public org.omg.CORBA.Object enableInsecureForObject(org.omg.CORBA.Object inObj)

Enables insecure server connection for this client object

Parameters:

inObj - is the object whose properties need modifying

Returns:

and object with the proper properties

getReqKeysAndValues

public java.lang.String[][] getReqKeysAndValues()

Returns the required keywords and possible values for each key for a particular implementation. Each row starts with the keyword, followed by acceptable values, no acceptable value means take the value as is.

Returns:

a 2D string array containing the keywords and values.

setReqKeysAndValues

public void setReqKeysAndValues(java.lang.String[][] inKeysAndValues)

Remembers the required HashMap of keywords and values for a particular implementation.

Parameters:

inKeysAndValues - is 2D array containing the data

See Also:

for the 2D array description

printReqKeysAndValues

public void printReqKeysAndValues(java.lang.String indent,
                                  java.io.PrintStream inPs)

Print the required keywords and their values.

Parameters:

indent - is the string to prepend to each line

getOptKeysAndValues

public java.lang.String[][] getOptKeysAndValues()

Returns the optional keywords and values for a particular implementation. Each row starts with the keyword, followed by acceptable values, no acceptable value means take the value as is. The first acceptable value is the default value

Returns:

a 2D string array containing the keywords and values.

setOptKeysAndValues

public void setOptKeysAndValues(java.lang.String[][] inKeysAndValues)

Remembers the optional keywords and values for a particular implementation

Parameters:

inKeysAndValues - is the 2D array containing the data

See Also:

for the 2D array description

printOptKeysAndValues

public void printOptKeysAndValues(java.lang.String indent,
                                  java.io.PrintStream inPs)

Print the optional keywords and their values.

Parameters:

indent - is the string to prepend to each line

getOptKeyDefault

public java.lang.String getOptKeyDefault(java.lang.String inKey)

Returns the default value for the optional keyword.

Parameters:

inKey - is the keyword to use as the key in the optional HashMap

Returns:

the first element in the associated string array for the keyword's associated value (a string array, or possibly null).

setApplet

public void setApplet(java.applet.Applet inApplet)

Set up for an applet

Parameters:

inApplet - is the applet using the factory

getApplet

public java.applet.Applet getApplet()

Returns the applet object if interface was setup for an applet, else null.

Returns:

the applet using the interface, may be null.

getTargetData

public java.util.Properties getTargetData(org.omg.CORBA.Object obj)

Get the data identifying the target that this object is connected to. Typically used by a client to identify the server connected to the object.

Parameters:

obj - is the object representing the server connection

Returns:

a properties sheet with the requested data. Typically, this will have a X509 subjectDN, quoter, and IP.

getClientData

public java.util.Properties getClientData(org.omg.CORBA.Object obj)

Get the data identifying the client that this object is connected to.

Parameters:

obj - is the object representing the server connection

Returns:

a properties sheet with the requested data. Typically, this will have a X509 subjectDN, quoter, and IP.

getClientData

public java.util.Properties getClientData()

Get the data identifying the client that is connected to this server associated with the service interface. Typically used by a server to identify the requesting client.

Returns:

a properties sheet with the requested data. Typically, this will have a X509 subjectDN, quoter, and IP.

getTargetData

public java.util.Properties getTargetData()

Get the data identifying the target that is connected to this server associated with the service interface.

Returns:

a properties sheet with the requested data. Typically, this will have a X509 subjectDN, quoter, and IP.

setQuotedId

public org.omg.CORBA.Object setQuotedId(org.omg.CORBA.Object inObj,
                                        java.util.Properties props)

Set the data identifying the client requestor.

Parameters:

inObj - is the object on which to set the new data

props - is the data to associate with the requestor object.

Returns:

a modified version of inObj with the properties set in/on it.

setQuotedId2Me

public org.omg.CORBA.Object setQuotedId2Me(org.omg.CORBA.Object inObj)

Set the quoted data identifying to be a copy of the subjectDN on the wire.

Parameters:

inObj - is the object on which to set the new data

Returns:

a modified version of inObj with the properties set in/on it.

getKeystore

public java.security.KeyStore getKeystore(java.lang.String path)

Loads a keystore from a file

Parameters:

path - is the pathname to the file containing a keystore may be null if verification is not desired

Returns:

the keystore read