All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class orbasec.SL2

java.lang.Object
   |
   +----orbasec.SL2

public class SL2
extends Object
This class is the programmer's entry point for ORBAsec initialization. Programmers must use this class to initialize the ORB, (optionally) the BOA, and the ORBAsec security mechanisms.

To obtain a reference to the ORB (and optionally the BOA) after initializing SL2, use the orb() and boa() acessors.

The SL2 class has a static reference to the current version (as a String):

     orbasec.SL2.Version
 
To print the SL2 Version to stout, simply run this class:
 promt% java orbasec.SL2
 


Variable Index

 o OwnInvocationCredentialsPolicy
Ready to go Invocation Credentials Policies.
 o ReceivedInvocationCredentialsPolicy
Ready to go Invocation Credentials Policies.
 o Version
This String represents the current SL2 version

Constructor Index

 o SL2()

Method Index

 o add_initial_services()
Adds ORB initial services (e.g., NameService), using the values defined in the argument list given to SL2.init().
 o boa()
 o create_delegation_directive_policy(DelegationDirective)
Creates an delegation directive policy.
 o create_establish_trust_policy(EstablishTrust)
Creates an establish trust policy.
 o create_invoc_creds_policy(Credentials[])
Creates an invocation credentials policy.
 o create_mechanism_policy(String[])
Creates a security mechanism policy.
 o create_qop_policy(QOP)
Creates a Quality of Protection Policy.
 o create_trusted_authority_policy(TrustedAuthorityPolicyContent)
 o debug(String)
Initialize Debug.
 o evaluation_license()
 o get_current()
 o get_properties()
This method returns the resultant properties after the ORB (and BOA) have been initialized.
 o get_vendor_initializer()
 o init(Applet, Properties)
Use this method to initialize a secure ORB for Applets.
 o init(ORB, BOA, String[])
Deprecated.
 o init(String[], Properties)
Use this method to initialize a secure ORB for "Client" standalone applications, i.e., applications that do not accept connections or act as CORBA servers.
 o init_with_boa(String[], Properties)
This method is shorthand for
 SL2.init_with_boa( argv, properties, properties );
 

This method initializes the ORB and BOA with the supplied command-line arguments and properties.

 o init_with_boa(String[], Properties, Properties)
Use this method to initialize a secure ORB for standalone applications that require a BOA, i.e., applications which function as CORBA servers.
 o main(String[])
 o orb()

Variables

 o Version
 public static final String Version
This String represents the current SL2 version

 o OwnInvocationCredentialsPolicy
 public static InvocationCredentialsPolicy OwnInvocationCredentialsPolicy
Ready to go Invocation Credentials Policies.

 o ReceivedInvocationCredentialsPolicy
 public static InvocationCredentialsPolicy ReceivedInvocationCredentialsPolicy
Ready to go Invocation Credentials Policies.

Constructors

 o SL2
 public SL2()

Methods

 o orb
 public static final ORB orb()
Returns:
the ORB that SL2 initialized
 o boa
 public static final BOA boa()
Returns:
the BOA that SL2 initialized (possibly null)
 o init
 public static void init(String argv[],
                         Properties orb_properties)
Use this method to initialize a secure ORB for "Client" standalone applications, i.e., applications that do not accept connections or act as CORBA servers.

This method initializes the ORB with the supplied command-line arguments and properties. It then initializes the ORBAsec security infrastructure.

This method should only be called once per process.

Parameters:
argv - command-line arguments passed to ORB.init
orb_properties - properties passed to ORB.init
 o init
 public static void init(Applet applet,
                         Properties orb_properties)
Use this method to initialize a secure ORB for Applets.

This method initializes the ORB with the supplied Applet and properties. It then initializes the ORBAsec security infrastructure.

Parameters:
applet - java.awt.Applet passed to ORB.init
orb_properties - properties passed to ORB.init
 o init_with_boa
 public static void init_with_boa(String argv[],
                                  Properties orb_properties,
                                  Properties boa_properties)
Use this method to initialize a secure ORB for standalone applications that require a BOA, i.e., applications which function as CORBA servers.

This method initializes the ORB and BOA with the supplied command-line arguments and properties. It then initializes the ORBAsec security infrastructure.

NOTE: The Properties defined in orb_properties have higher precedence than those defined in boa_properties. That is, any property defined in boa_properties that is also defined in orb_properties will take the value of orb_properties by the time the ORB and BOA are initialized. Use the single-Properties init_with_boa method if the Properties are the same for the ORB and BOA (as they typically are). This method is provided only for consistency.

Parameters:
argv - command-line arguments passed to ORB.init
orb_properties - properties passed to ORB.init
boa_properties - properties passed to ORB.BOA_init
 o init_with_boa
 public static void init_with_boa(String argv[],
                                  Properties properties)
This method is shorthand for
 SL2.init_with_boa( argv, properties, properties );
 

This method initializes the ORB and BOA with the supplied command-line arguments and properties. It then initializes the ORBAsec security infrastructure.

Parameters:
argv - command-line arguments passed to ORB.init
properties - properties passed to ORB.init and ORB.BOA_init
 o init
 public static void init(ORB orb,
                         BOA boa,
                         String args[])
Note: init() is deprecated. SL2 now initializes ORB (and possibly boa). Use one of
  • init( String[], java.util.Properties)
  • init( java.applet.Applet, java.util.Properties)
  • init_with_boa( String[], java.util.Properties, java.util.Properties)
  • init_with_boa( String[], java.util.Properties)
  •  o get_properties
     public static Properties get_properties()
    
    This method returns the resultant properties after the ORB (and BOA) have been initialized.

    Returns:
    resulting properties
     o add_initial_services
     public static void add_initial_services()
    
    Adds ORB initial services (e.g., NameService), using the values defined in the argument list given to SL2.init().

     o debug
     protected static void debug(String conf_file)
    
    Initialize Debug. The conf_file contains a java.util.Properties file containing boolean values for various debug capabilities. If the property "debug" is true, then mountains of of seemingly random information comes out not always even understood by the developers!. The other two boolean properties that are supported are SECIOP and SECIOP_HEXDUMPS.

     o create_qop_policy
     public static QOPPolicy create_qop_policy(QOP qop)
    
    Creates a Quality of Protection Policy.

    Parameters:
    qop - The Quality of Protection.
    Returns:
    A policy object for Quality of Protection.
     o create_mechanism_policy
     public static MechanismPolicy create_mechanism_policy(String mechanisms[])
    
    Creates a security mechanism policy.

    Parameters:
    mechansims - This argument contains an ordered list of security mechanisms.
    Returns:
    A policy object for mechanisms.
     o create_invoc_creds_policy
     public static InvocationCredentialsPolicy create_invoc_creds_policy(Credentials creds[])
    
    Creates an invocation credentials policy.

    Parameters:
    creds - This argument gives the list of credentials to use for invocations.
    Returns:
    A policy object for invocations credentials.
     o create_establish_trust_policy
     public static EstablishTrustPolicy create_establish_trust_policy(EstablishTrust trust)
    
    Creates an establish trust policy.

    This policy should really be called establish authentication in its current form.

    Parameters:
    client_trust - This argument states that when applied to invocations, on the client side credentials will be given to the target for authentication. On the server side it stipulates whehter it is mandatory for the client to be authenticated.
    target_trust - This argument states that when applied to invocations, on the server side credentials will be given to the client for authentication. On the server side it stipulates whehter it is mandatory for the target to be authenticated.
    Returns:
    A policy object for establishing authentication.
     o create_delegation_directive_policy
     public static DelegationDirectivePolicy create_delegation_directive_policy(DelegationDirective delegation_directive)
    
    Creates an delegation directive policy.

    Parameters:
    delegation_directive - This argument states that when applied to invocations, on the client side credentials should be delegated to the target. On the server side it stipulates whehter it is mandatory for the client to have given credentials that he can use for other invocations.
    Returns:
    A policy object for delegation directive.
     o create_trusted_authority_policy
     public static TrustedAuthorityPolicy create_trusted_authority_policy(TrustedAuthorityPolicyContent trusted_authorities)
    
    Parameters:
    trusted_authorities - The trusted authorities
    Returns:
    A policy object for TrustedAuthorityPolicy.
     o get_current
     public static final Current get_current()
    
    Returns:
    the SecurityLevel2.Current.
     o get_vendor_initializer
     public static VendorInitializer get_vendor_initializer()
    
    Returns:
    the VendorInitializer; there should be only 1
     o evaluation_license
     public static final void evaluation_license()
    
     o main
     public static void main(String argv[])
    

    All Packages  Class Hierarchy  This Package  Previous  Next  Index