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

Class CognosManager

  • java.lang.Object
    • com.ibm.tivoli.maximo.report.cognos.metadata.player.CognosManager

  • public class CognosManager
extends java.lang.Object
    This class is responsible for handling all the communications with the Cognos Server.

    • Constructor Summary

      Constructors 
      Constructor and Description
      CognosManager(java.lang.String url, java.lang.String namespaeId, java.lang.String userName, java.lang.String password)
      This constructor is responsible for:
      1.
      CognosManager(java.lang.String url, java.lang.String namespaceId, java.lang.String userName, java.lang.String token, java.lang.String tokenurl)
      This constructor is responsible for:
      1.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void closeModel(java.lang.String projectLocation)
      This method is responsible for closing the framework manager located in the specified location.
      void createModel(java.lang.String projectLocation)
      This method is responsible for creating a new framework manager model on the specified location on the Cognos server.
      void executeTransaction(java.lang.String projectLocation, java.lang.String transaction)
      This method is responsible for executing a transaction on a framework manager project located in the specified location.
      void executeTransientCreateAction(java.lang.String projectLocation, java.lang.String transaction)
      This method is responsible for creating a new framework manager model on the specified location on the Cognos server and executing a transaction.
      void openModel(java.lang.String projectLocation)
      This method is responsible for opening the framework manager located in the specified location.
      void saveModel(java.lang.String projectLocation)
      This method is responsible for saving the framework manager located in the specified location.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CognosManager

        public CognosManager(java.lang.String url,
                     java.lang.String namespaeId,
                     java.lang.String userName,
                     java.lang.String password)
        This constructor is responsible for:
        1. connecting to the Cognos server.
        2. login to the server, if the user name is null or empty string, login will be using anonymous user.
        3. initializing the metatdata service.
        Parameters:
        url - the url of the Cognos Server, it is the value provided in the "IBM Cognos Configuration" tool: in Local Configuration -> Environment -> Dispatcher URI for external applications
        namespaeId - the namespace for the authentication provider configured on Cognos Server. It is the value provided in the "IBM Cognos Configuration" tool: in Local Configuration -> Security -> Authentication -> ->Namespace ID
        userName - the username of the Cognos user
        password - the password og the Cognos user
        Throws:

      • CognosManager

        public CognosManager(java.lang.String url,
                     java.lang.String namespaceId,
                     java.lang.String userName,
                     java.lang.String token,
                     java.lang.String tokenurl)
        This constructor is responsible for:
        1. connecting to the Cognos server.
        2. login to the server, if the user name is null or empty string, login will be using anonymous user.
        3. initializing the metatdata service.
        Parameters:
        url - the url of the Cognos Server, it is the value provided in the "IBM Cognos Configuration" tool: in Local Configuration -> Environment -> Dispatcher URI for external applications
        namespaeId - the namespace for the authentication provider configured on Cognos Server. It is the value provided in the "IBM Cognos Configuration" tool: in Local Configuration -> Security -> Authentication -> ->Namespace ID
        userName - the username of the Cognos user
        token - the token of the Cognos user
        tokenurl - the authentication url used by MXCSP for token authentication
        Throws:

    • Method Detail

      • executeTransientCreateAction

        public void executeTransientCreateAction(java.lang.String projectLocation,
                                         java.lang.String transaction)
                                  throws CognosHandlerException
        This method is responsible for creating a new framework manager model on the specified location on the Cognos server and executing a transaction. The entire action log is include in a single transaction.
        Parameters:
        projectLocation - the location where the framework manager project will be created
        transaction - the transaction to be executed on the Cognos server
        Throws:
        CognosHandlerException - if exception occurred during creating the project or executing the transaction

      • createModel

        public void createModel(java.lang.String projectLocation)
                 throws CognosHandlerException
        This method is responsible for creating a new framework manager model on the specified location on the Cognos server.
        Parameters:
        projectLocation - the location where the framework manager project will be created
        Throws:
        CognosHandlerException - if exception occurred during creating the project

      • openModel

        public void openModel(java.lang.String projectLocation)
               throws CognosHandlerException
        This method is responsible for opening the framework manager located in the specified location.
        Parameters:
        projectLocation - the location for the framework manager project to be opened
        Throws:
        CognosHandlerException - if exception occurred during opening the project

      • saveModel

        public void saveModel(java.lang.String projectLocation)
               throws CognosHandlerException
        This method is responsible for saving the framework manager located in the specified location.
        Parameters:
        projectLocation - the location for the framework manager project to be saved
        Throws:
        CognosHandlerException - if exception occurred during saving the project

      • closeModel

        public void closeModel(java.lang.String projectLocation)
                throws CognosHandlerException
        This method is responsible for closing the framework manager located in the specified location.
        Parameters:
        projectLocation - the location for the framework manager project to be closed
        Throws:
        CognosHandlerException - if exception occurred during closing the project

      • executeTransaction

        public void executeTransaction(java.lang.String projectLocation,
                               java.lang.String transaction)
                        throws CognosHandlerException
        This method is responsible for executing a transaction on a framework manager project located in the specified location.
        Parameters:
        projectLocation - the location for the framework manager project
        transaction - the transaction to be executed on the Cognos server
        Throws:
        CognosHandlerException - if exception occurred during executing the transaction
Skip navigation links