org.josef.util.appserver

Class ApplicationServerUtil

java.lang.Object

org.josef.util.appserver.ApplicationServerUtil

@Status(stage=PRODUCTION,
        unitTests=ABSENT)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public final class ApplicationServerUtil
extends Object

Utility class to handle generic and specific application server specific functionality.
For application server specific functionality, the actual implementation comes from another jar like josef-weblogic.jar or josef-websphere.jar depending on the application server specified in GlobalSettings.

Version:

1.0 $Revision: 6483 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
static ApplicationServerUtilInterface	createApplicationServerUtilInstance() Creates a new application server utility class for the current application server.
static InitialContext	getInitialContext() Creates and returns an initial context.
static DataSource	lookupDataSource(Context context, String name) Convenience method for looking up a data source.
static UserTransaction	lookupUserTransaction(Context context) Looks up the user transaction.
static void	main(String[] args) For test purposes only.

Methods inherited from class java.lang.Object

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

Method Detail

createApplicationServerUtilInstance

public static ApplicationServerUtilInterface createApplicationServerUtilInstance()

Creates a new application server utility class for the current application server.
The current application server is determined by the GlobalSettings.

Returns:

A concrete instance of ApplicationServerUtilInterface.

Throws:

IllegalStateException - When no, an unknown or unsupported application server is fetched from the GlobalSettings or when the corresponding utility class could not be loaded.

getInitialContext

public static InitialContext getInitialContext()
                                        throws NamingException

Creates and returns an initial context.
This method assumes that all JNDI properties are either specified as system properties or as properties stored in a jndi.properties file.

Returns:

Initial context.

Throws:

NamingException - When an initial context could not be looked up.
This exception is logged with a level of Level.ERROR.

lookupDataSource

public static DataSource lookupDataSource(Context context,
                                          String name)
                                   throws NamingException

Convenience method for looking up a data source.

Parameters:

context - The JNDI Context to use for the lookup.

name - The name of the data source that must be looked up.

Returns:

The looked up data source.

Throws:

IllegalArgumentException - When the supplied name is empty.

NamingException - When the supplied data source could not be looked up.

NullPointerException - When the supplied context or name is null.

lookupUserTransaction

public static UserTransaction lookupUserTransaction(Context context)
                                             throws NamingException

Looks up the user transaction.
Different application servers use different JNDI names to lookup the user transaction. This method uses GlobalSettings to get the currently used application server.

Parameters:

context - The JNDI Context to use for the lookup.

Returns:

User transaction object.

Throws:

NamingException - When the transaction could not be looked up.

NullPointerException - When the supplied context is null.

main

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

For test purposes only.
Lists users from the LDAP server that is embedded within a WebLogic server. This method assumes that:

• Credentials of the embedded LDAP have been changed to weblogic
• WebLogic runs on localhost:7001
• WebLogic's Domain name is LdapDomain

Please adapt the parameters in this method to your local situation.

Parameters:

args - Not used.

Throws:

NamingException - When the LDAP context could not be obtained.