com.ibm.ims.base
Class IMSInfo

java.lang.Object
  |
  +--com.ibm.ims.base.IMSInfo

public final class IMSInfo
extends java.lang.Object

The IMSInfo class provides information about the application's current execution environment. This information is determined by making the System Service Call INQY with the ENVIRON subfunction. This includes the IMS identifier, release, region, program name, PSB name, transaction name, user identifier, group name, and status group indicator.


Method Summary
 java.lang.String applicationRegionType()
          Returns IMS active application region type.
 java.lang.String controlRegionType()
          Returns the active IMS Control Region Type.
static IMSInfo getIMSInfo()
          Creates an IMSInfo object containing information about the IMS system.
 java.lang.String groupName()
          Returns the Group Name.
 java.lang.String programName()
          Returns the Application Program Name of the application program being run.
 java.lang.String psbName()
          Returns the name of the PSB currently allocated
 int regionID()
          Returns the IMS Region Identifier.
 int releaseLevel()
          Returns IMS Release Level.
 java.lang.String statusGroupIndicator()
          Returns the Status Group Indicator.
 java.lang.String systemID()
          Returns the identifier from the execute parameters.
 java.lang.String transactionName()
          Returns the name of the transaction.
 java.lang.String userID()
          Returns the user ID derived from the PSTUSID field of the PST that represents the region making the INQY ENVIRON call.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

applicationRegionType

public java.lang.String applicationRegionType()
Returns IMS active application region type. The active region could be BATCH (IMS Batch), BMP (Batch Message Processing), IFP (IMS Fast Path) or MPP (Message Processing).
Returns:
the active IMS application region type

controlRegionType

public java.lang.String controlRegionType()
Returns the active IMS Control Region Type. The active region type could be BATCH (IMS Batch), DB (only the IMS Database Manager is active -- DBCTL system), TM (only the IMS Transaction Manager is active -- DCCTL system), or DB/DC (both the IMS Database and Transaction managers are active -- DB/DC system),
Returns:
the active IMS Control Region Type

getIMSInfo

public static final IMSInfo getIMSInfo()
                                throws IMSException
Creates an IMSInfo object containing information about the IMS system.
Returns:
a new IMSInfo object containing the IMS system information
Throws:
IMSException - if a non-blank status code is returned from the system call

groupName

public java.lang.String groupName()
Returns the Group Name.
Returns:
the Group Name or blanks if the Group Name is unavailable.

programName

public java.lang.String programName()
Returns the Application Program Name of the application program being run.
Returns:
the Application Program Name

psbName

public java.lang.String psbName()
Returns the name of the PSB currently allocated
Returns:
the PSB name

regionID

public int regionID()
Returns the IMS Region Identifier.
Returns:
the IMS Region Identifier

releaseLevel

public int releaseLevel()
Returns IMS Release Level. For example, for IMS Versio 7 Release 1, 710 will be returned.
Returns:
the Release Level for IMS

statusGroupIndicator

public java.lang.String statusGroupIndicator()
Returns the Status Group Indicator. The indicator could be A (INIT STATUS GROUPA call is issued), B (INIT STATUS GROUPB call is issued).
Returns:
IMS Status Group indicator or blank if a status group is not initialized.

systemID

public java.lang.String systemID()
Returns the identifier from the execute parameters.
Returns:
the IMS system Identifier

transactionName

public java.lang.String transactionName()
Returns the name of the transaction.
Returns:
the transaction name or blanks if there is no transaction.

userID

public java.lang.String userID()
Returns the user ID derived from the PSTUSID field of the PST that represents the region making the INQY ENVIRON call.
Returns:
the user ID or blanks if the user ID is unavailable.


(C) International Business Machines Corporation 2004. All rights reserved.