com.ibm.tivoli.maximo.report.cognos.metadata.adapter

Class CognosHandler

java.lang.Object

psdi.iface.router.BaseRouterHandler

com.ibm.tivoli.maximo.report.cognos.metadata.adapter.CognosHandler

All Implemented Interfaces:

RouterHandler

public class CognosHandler
extends BaseRouterHandler

This is a Cognos handler class that is responsible for communicating with Cognos as an external system using the Cognos SDK Java APIs. The class doesn't communicate directly with Cognos APIs. It relies on ActionLogPlayer for interacting with Cognos. Therefore, the CognosHandler role is to hook the ActionLogPlayer with the Maximo integration framework by wrapping it as a handler like other handlers (EJB Handler, Web Service Handler, etc.).

This handler has five properties. All of them are mandatory. Properties are:

1. URL - this is the url of the Cognos server.
2. Namespace Id - the Cognos Namespace Id.
3. Project Base Directory - Project location on the file system at the Cognos server.
4. Data Source Name - Data source name of the Maximo database connection defined at the Cognos server.
5. Cognos SDK Location - Folder location of the COGNOS SDK at the Maximo applicaton server.
6. Username - Username for a user that has privilege to access and upload Cognos packages.
7. Password - Password for a user that has privilege to access and upload Cognos packages

See Also:

ActionLogPlayer}

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHENTICATION_METHOD A Constant for retrieving the Cognos "Authentication Method" handler property (Valid Values: LDAP, MXCSP)
static java.lang.String	CONTENT_STORE_PACKAGE_LOCATION A Constant for retrieving the Cognos "Content store package location" handler property
static java.lang.String	DATA_SOURCE_NAME A Constant for retrieving the Cognos "Data Source Name" handler property
static java.lang.String	MULTISERVER_ENABLED A Constant for retrieving the Cognos "Is Multiserver Enabled?" handler property
static java.lang.String	NAMESPACE_ID A Constant for retrieving the Cognos "Namespace ID" handler property.
static java.lang.String	PROJECT_BASE_DIR A Constant for retrieving the Cognos "Project Base Directory" handler property
static java.lang.String	URL A Constant for retrieving the Cognos "URL" handler property.

Fields inherited from class psdi.iface.router.BaseRouterHandler

endPointPropVals, epName, metaData

Fields inherited from interface psdi.iface.router.RouterHandler

BIDICONFIG, PASSWORD, USERNAME

Constructor Summary

Constructors

Constructor and Description
CognosHandler() Initialise CognosHandler without parameters.
CognosHandler(MaxEndPointInfo endPointInfo) Initialise CognosHandler with end point information.

Method Summary

Modifier and Type	Method and Description
java.util.List	getProperties() Returns list of RouterPropsInfo objects that represent the handler properties.
byte[]	invoke(java.util.Map metadata, byte[] data) Uses the ActionLogPlayer to invokes the Cognos Java SDK APIs to upload the cognos action logs and publish them in Cognos.
static void	setUserInfo(UserInfo userInfo)

Methods inherited from class psdi.iface.router.BaseRouterHandler

getBooleanPropertyValue, getBooleanPropertyValue, getDatePropertyValue, getDoublePropertyValue, getIntPropertyValue, getLongPropertyValue, getOverrideValue, getPropertyValue, isOverridden, isPropertyOverridable

Methods inherited from class java.lang.Object

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

Field Detail

URL

public static final java.lang.String URL

A Constant for retrieving the Cognos "URL" handler property.

See Also:

Constant Field Values

NAMESPACE_ID

public static final java.lang.String NAMESPACE_ID

A Constant for retrieving the Cognos "Namespace ID" handler property.

See Also:

Constant Field Values

PROJECT_BASE_DIR

public static final java.lang.String PROJECT_BASE_DIR

A Constant for retrieving the Cognos "Project Base Directory" handler property

See Also:

Constant Field Values

DATA_SOURCE_NAME

public static final java.lang.String DATA_SOURCE_NAME

A Constant for retrieving the Cognos "Data Source Name" handler property

See Also:

Constant Field Values

CONTENT_STORE_PACKAGE_LOCATION

public static final java.lang.String CONTENT_STORE_PACKAGE_LOCATION

A Constant for retrieving the Cognos "Content store package location" handler property

See Also:

Constant Field Values

AUTHENTICATION_METHOD

public static final java.lang.String AUTHENTICATION_METHOD

A Constant for retrieving the Cognos "Authentication Method" handler property (Valid Values: LDAP, MXCSP)

See Also:

Constant Field Values

MULTISERVER_ENABLED

public static final java.lang.String MULTISERVER_ENABLED

A Constant for retrieving the Cognos "Is Multiserver Enabled?" handler property

See Also:

Constant Field Values

Constructor Detail

CognosHandler

public CognosHandler()

Initialise CognosHandler without parameters.

CognosHandler

public CognosHandler(MaxEndPointInfo endPointInfo)

Initialise CognosHandler with end point information.

Parameters:

endPointInfo -

Method Detail

setUserInfo

public static void setUserInfo(UserInfo userInfo)

getProperties

public java.util.List getProperties()

Returns list of RouterPropsInfo objects that represent the handler properties.

Returns:

List

invoke

public byte[] invoke(java.util.Map metadata,
                     byte[] data)
              throws MXException

Uses the ActionLogPlayer to invokes the Cognos Java SDK APIs to upload the cognos action logs and publish them in Cognos.

Specified by:

invoke in interface RouterHandler

Overrides:

invoke in class BaseRouterHandler

Parameters:

metadata - Metadata as Map.

data - Cognos Action Logs as byte[].

Returns:

Cognos invocation acknowledgement as an Object Structure in the format of byte array.

Throws:

MXException

See Also:

ActionLogPlayer}