wt.sysadm
Class SysAdmServletHelper

java.lang.Object
  wt.sysadm.SysAdmServletHelper

public class SysAdmServletHelper

extends Object

The SysAdmServletHelper class is designed to work with the URLFactory to provide a series of accessory methods to build invokations through the System Administrator gateway.

This class's scope should not be extended beyond the construction of requests for System Admin gateways. If other gateways are required, they should be created based on the implementation provided here.

The SysAdmServletHelper utilizes the URLFactory to create and return HREFs according to the current context. If the URLFactory's requestURI is set, a relative HREF will be returned if possible. If no requestURI is present the HREF will be relative to the Windchill codebase.

For example, if an System Administration gateway was set to http://hostname/Windchill/servlet/WindchillSAGW and the requestURI for the URLFactory is set to the codebase (in this example http://hostname/Windchill)
a call to

buildSysAdmHREF( aURLFactory, "wt.httpgw.HTTPServer", "echo", null )

would return the String "servlet/WindchillSAGW/wt.httpgw.HTTPServer/echo"

See Also:

URLFactory

Supported API: true
Extendable: false

Field Summary

static String	SYSADM_URL Constant for SysAdm URL
private static HashMap	SysAdmMap Map of all SysAdm mappings

Constructor Summary

SysAdmServletHelper()

Method Summary

static String	buildSysAdmHREF(URLFactory aFactory) Will return an HREF String to the SysAdm Gateway.
static String	buildSysAdmHREF(URLFactory aFactory, String aClass) Will return an HREF String to the SysAdm Gateway.
static String	buildSysAdmHREF(URLFactory aFactory, String c, String m, HashMap params) Will return a HREF String for a class and method invoked through the SysAdm Gateway.
static String	buildSysAdmHREF(URLFactory aFactory, String c, String m, String params) Will return a HREF String for a class and method invoked through the SysAdm Gateway.
static String	buildSysAdmHREF(URLFactory aFactory, String c, String m, String f, HashMap params) Will return a HREF String for a class and method invoked through the SysAdm Gateway.
static String	buildSysAdmHREF(URLFactory aFactory, String c, String m, String f, String params) Will return a HREF String for a class and method invoked through the SysAdm Gateway.
private static String	buildSysAdmMethodCall(URLFactory aFactory, String c, String m, String f) Using an URLFactory build a proper string for the package-path and resource for the desired class, method and optional file.
static URL	buildSysAdmURL(URLFactory aFactory) Will return a URL for a class and method invoked through the SysAdm Gateway.
static URL	buildSysAdmURL(URLFactory aFactory, String aClass) Will return a URL for a class and method invoked through the SysAdm Gateway.
static URL	buildSysAdmURL(URLFactory aFactory, String aClass, HashMap params) Will return a URL for a class and method invoked through the SysAdm Gateway.
static URL	buildSysAdmURL(URLFactory aFactory, String aClass, String params) Will return a URL for a class and method invoked through the SysAdm Gateway.
static URL	buildSysAdmURL(URLFactory aFactory, String c, String m, HashMap params) Will return a URL for a class and method invoked through the SysAdm Gateway.
static URL	buildSysAdmURL(URLFactory aFactory, String c, String m, String params) Will return a URL for a class and method invoked through the SysAdm Gateway.
static URL	buildSysAdmURL(URLFactory aFactory, String c, String m, String f, HashMap params) Will return a URL for a class and method invoked through the SysAdm Gateway.
static URL	buildSysAdmURL(URLFactory aFactory, String c, String m, String f, String params) Will return a URL for a class and method invoked through the SysAdm Gateway.

Methods inherited from class java.lang.Object

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

Field Detail

SYSADM_URL

public static final String SYSADM_URL

Constant for SysAdm URL

See Also:

Constant Field Values

SysAdmMap

private static HashMap SysAdmMap

Map of all SysAdm mappings

Constructor Detail

SysAdmServletHelper

public SysAdmServletHelper()

Method Detail

buildSysAdmHREF

public static final String buildSysAdmHREF(URLFactory aFactory)
                                    throws WTException

Will return an HREF String to the SysAdm Gateway.

Parameters:

aFactory - The current URLFactory

Returns:

The SysAdm HREF for the gateway

Throws:

WTException

buildSysAdmHREF

public static final String buildSysAdmHREF(URLFactory aFactory,
                                           String aClass)
                                    throws WTException

Will return an HREF String to the SysAdm Gateway.

Parameters:

aFactory - The current URLFactory

aClass - The class or resource

Returns:

The SysAdm HREF for the gateway

Throws:

WTException

buildSysAdmHREF

public static final String buildSysAdmHREF(URLFactory aFactory,
                                           String c,
                                           String m,
                                           String params)
                                    throws WTException

Will return a HREF String for a class and method invoked through the SysAdm Gateway. If URLFactory is null, a new URLFactory will be instantiated to handle the request, however an instance should be passed in whereever possble.

Parameters:

aFactory - The current URLFactory

c - The class to add to the href

m - The method to be invoked by the class

params - The parameter string encoded already

Throws:

WTException - If the server-codebase could not be reached.

buildSysAdmHREF

public static final String buildSysAdmHREF(URLFactory aFactory,
                                           String c,
                                           String m,
                                           HashMap params)
                                    throws WTException

Will return a HREF String for a class and method invoked through the SysAdm Gateway. If URLFactory is null, a new URLFactory will be instantiated to handle the request, however an instance should be passed in whereever possble.

Parameters:

aFactory - The current URLFactory

c - The class to add to the href

m - The method to be invoked by the class

params - The parameter hashmap not encoded.

Throws:

WTException - If the server-codebase could not be reached.

buildSysAdmHREF

public static final String buildSysAdmHREF(URLFactory aFactory,
                                           String c,
                                           String m,
                                           String f,
                                           String params)
                                    throws WTException

Will return a HREF String for a class and method invoked through the SysAdm Gateway. If URLFactory is null, a new URLFactory will be instantiated to handle the request, however an instance should be passed in whereever possble. The parameter String is pre-encoded.

Parameters:

aFactory - The current URLFactory

c - The class to add to the href

m - The method to be invoked by the class

f - The filename appended to the URI

params - The parameter string is pre-encoded encoded.

Throws:

WTException - If the server-codebase could not be reached.

buildSysAdmHREF

public static final String buildSysAdmHREF(URLFactory aFactory,
                                           String c,
                                           String m,
                                           String f,
                                           HashMap params)
                                    throws WTException

Will return a HREF String for a class and method invoked through the SysAdm Gateway. If URLFactory is null, a new URLFactory will be instantiated to handle the request, however an instance should be passed in whereever possble.

Parameters:

aFactory - The current URLFactory

c - The class to add to the href

m - The method to be invoked by the class

f - The filename appended to the URI

params - The parameter hashmap not encoded.

Throws:

WTException - If the server-codebase could not be reached.

buildSysAdmMethodCall

private static final String buildSysAdmMethodCall(URLFactory aFactory,
                                                  String c,
                                                  String m,
                                                  String f)
                                           throws WTException

Using an URLFactory build a proper string for the package-path and resource for the desired class, method and optional file.

If the URLFactory's codebase is defined as http://hostname/Windchill and the SysAdm url in the wt.properties file is http://hostname/Windchill/somepathToGateway then this method should return a string of the form somepathToGateway/Class/ Method[/file]

Parameters:

aFactory - The URLFactory instance.

c - The class.

m - The method.

f - The file

Returns:

The String to the method using the gateway

Throws:

WTException - If the server-codebase could not be reached.

buildSysAdmURL

public static final URL buildSysAdmURL(URLFactory aFactory)
                                throws WTException

Will return a URL for a class and method invoked through the SysAdm Gateway. If URLFactory is null, a new URLFactory will be instantiated to handle the request, however an instance should be passed in whenever possble.

Parameters:

aFactory - The current URLFactory

Throws:

WTException - If the server-codebase could not be reached.

buildSysAdmURL

public static final URL buildSysAdmURL(URLFactory aFactory,
                                       String aClass)
                                throws WTException

Will return a URL for a class and method invoked through the SysAdm Gateway. If URLFactory is null, a new URLFactory will be instantiated to handle the request, however an instance should be passed in whenever possble.

Parameters:

aFactory - The current URLFactory

aClass - The class to append to the URL.

Throws:

WTException - If the server-codebase could not be reached.

buildSysAdmURL

public static final URL buildSysAdmURL(URLFactory aFactory,
                                       String aClass,
                                       String params)
                                throws WTException

Will return a URL for a class and method invoked through the SysAdm Gateway. If URLFactory is null, a new URLFactory will be instantiated to handle the request, however an instance should be passed in whenever possble.

Parameters:

aFactory - The current URLFactory

aClass - The class to append to the URL.

params - The encoded parameter string

Throws:

WTException - If the server-codebase could not be reached.

buildSysAdmURL

public static final URL buildSysAdmURL(URLFactory aFactory,
                                       String aClass,
                                       HashMap params)
                                throws WTException

Will return a URL for a class and method invoked through the SysAdm Gateway. If URLFactory is null, a new URLFactory will be instantiated to handle the request, however an instance should be passed in whenever possble.

Parameters:

aFactory - The current URLFactory

aClass - The class to append to the URL.

params - The hashmap of parameters

Throws:

WTException - If the server-codebase could not be reached.

buildSysAdmURL

public static final URL buildSysAdmURL(URLFactory aFactory,
                                       String c,
                                       String m,
                                       String params)
                                throws WTException

Will return a URL for a class and method invoked through the SysAdm Gateway. If URLFactory is null, a new URLFactory will be instantiated to handle the request, however an instance should be passed in whenever possble.

Parameters:

aFactory - The current URLFactory

c - The class to add to the href

m - The method to be invoked by the class

params - The parameter string encoded.

Throws:

WTException - If the server-codebase could not be reached.

buildSysAdmURL

public static final URL buildSysAdmURL(URLFactory aFactory,
                                       String c,
                                       String m,
                                       HashMap params)
                                throws WTException

Will return a URL for a class and method invoked through the SysAdm Gateway. If URLFactory is null, a new URLFactory will be instantiated to handle the request, however an instance should be passed in whenever possble.

Parameters:

aFactory - The current URLFactory

c - The class to add to the href

m - The method to be invoked by the class

params - The parameter hashmap not encoded.

Throws:

WTException - If the server-codebase could not be reached.

buildSysAdmURL

public static final URL buildSysAdmURL(URLFactory aFactory,
                                       String c,
                                       String m,
                                       String f,
                                       String params)
                                throws WTException

Will return a URL for a class and method invoked through the SysAdm Gateway. If URLFactory is null, a new URLFactory will be instantiated to handle the request, however an instance should be passed in whenever possble.

Parameters:

aFactory - The current URLFactory

c - The class to add to the href

m - The method to be invoked by the class

f - The filename to be added to the end of URI

params - The parameter string encoded.

Throws:

WTException - If the server-codebase could not be reached.

buildSysAdmURL

public static final URL buildSysAdmURL(URLFactory aFactory,
                                       String c,
                                       String m,
                                       String f,
                                       HashMap params)
                                throws WTException

Will return a URL for a class and method invoked through the SysAdm Gateway. If URLFactory is null, a new URLFactory will be instantiated to handle the request, however an instance should be passed in whenever possble.

Parameters:

aFactory - The current URLFactory

c - The class to add to the href

m - The method to be invoked by the class

f - The filename to be added to the end of URI

params - The parameter hashmap not encoded.

Throws:

WTException - If the server-codebase could not be reached.