public interface OmpServiceRemote extends AppServiceRemote
Modifier and Type | Field and Description |
---|---|
static int |
CORRECT_CONTEXT
Return value from checkContext; the launch entry context(s)
match the given MBO.
|
static java.lang.String |
CREDENTIAL_MAPPER_CLASSNAME_PROPERTY
The name of the Maximo property that stores the credential mapper classname.
|
static int |
INCORRECT_CONTEXT
Return value from checkContext; the launch entry context(s) do
not match the given MBO.
|
static int |
NO_CONTEXT_NEEDED
Return value from checkContext; the launch entry does
not have any contexts, so any MBO will match it.
|
Modifier and Type | Method and Description |
---|---|
int |
checkContext(MaxLaunchEntryInfo entry,
MboRemote mainMbo)
Checks to see if the given launch entry should be available from an application
with the given main MBO.
|
java.lang.String |
getCIGUIDFromMBO(MboRemote mainMbo)
Tries to get the CI GUID from the given MBO in two ways.
|
BaseCredentialMapper |
getCredentialMapper(UserInfo userInfo,
java.lang.String endPointName)
Returns the credential mapper for this endpoint and user.
|
MaxIMSetRemote |
getIMListForLMO(java.lang.String lmoName,
java.lang.String lmoNamespace)
Gets the list of Integration Modules that implement the specified Logical Management Operation.
|
MaxIMSetRemote |
getIMListForLMOWithOMP(java.lang.String lmoName,
java.lang.String lmoNamespace)
Gets the list of Integration Modules that implement the specified Logical Management Operation
on at least one Operational Management Product.
|
MaxIMSetRemote |
getIMListForOMP(java.lang.String ompGuid)
Gets the list of Integration Modules that implement at least one Logical Management Operation
on the given Operational Management Product.
|
java.util.Collection |
getIMListForOMPAndLMO(java.lang.String ompGUID,
java.lang.String lmoName,
java.lang.String lmoNamespace)
Gets the list of Integration Modules that implement the specified Logical Management Operation
on the specified Operational Management Product.
|
java.util.Collection |
getIMListForOMPAndLMO(java.lang.String ompHostname,
java.lang.String ompProductname,
java.lang.String ompManufacturer,
java.lang.String lmoName,
java.lang.String lmoNamespace)
Gets the list of Integration Modules that implement the specified Logical Management Operation
on the specified Operational Management Product.
|
MaxLaunchEntryInfo |
getLaunchEntry(java.lang.String launchEntryName)
Given a launch entry name, get the MaxLaunchEntry.
|
LMOSetRemote |
getLMOListForIM(java.lang.String imName,
java.lang.String imVersion)
Gets the Logical Management Operations implemented by the specified Integration Module.
|
LMOSetRemote |
getLMOListForOMP(java.lang.String ompGuid)
Gets the Logical Management Operations that are implemented by at least one Integration Module
on the given Operational Management Product.
|
LMOSetRemote |
getLMOsNotAssociatedWithIM(MboRemote imMbo)
Get the Logical Management Operations that are not associated with an Integration Module.
|
LMOSetRemote |
getLMOsNotAssociatedWithIMAndOmp(MboRemote ompImRel)
Given an OmpImRel, returns the set of LMOs that
are implemented by the IM, but not on the OMP.
|
OmpSetRemote |
getOMPList(java.lang.String launchEntryName,
MboRemote mainMbo)
Given a Launch Entry name and a MBO, return a list of OMPs that
this Launch Entry can launch to.
|
OmpSetRemote |
getOMPListForIM(java.lang.String imName,
java.lang.String imVersion)
Gets a list of the Operational Management Products associated with the given Integration Module.
|
OmpSetRemote |
getOMPListForLMO(java.lang.String ompProductName,
java.lang.String lmoName,
java.lang.String lmoNamespace)
Gets a list of all the Operational Management Products with the specified product name
that are associated with the specified Logical Management Operation.
|
OmpImLmoRelInfo |
getPreferredIM(java.lang.String ompGUID,
java.lang.String lmoName,
java.lang.String lmoNamespace)
Gets the preferred Integration Module that implements the specified Logical Management Operation
on the specified Operational Management Product.
|
OmpImLmoRelInfo |
getPreferredIM(java.lang.String ompHostname,
java.lang.String ompProductname,
java.lang.String ompManufacturer,
java.lang.String lmoName,
java.lang.String lmoNamespace)
Gets the preferred Integration Module that implements the specified Logical Management Operation
on the specified Operational Management Product.
|
java.util.Map |
getServiceInvoker(OmpImLmoRelInfo ompImLmoRelInfo,
UserInfo userInfo)
Returns the ServiceInvoker for the specified Integration Module.
|
java.util.Map |
getServiceInvoker(OmpImLmoRelRemote ompImLmoRelRemote,
UserInfo userInfo)
Gets the ServiceInvoker for the specified Integration Module.
|
java.util.Map |
getServiceInvoker(java.lang.String ompGUID,
java.lang.String imName,
java.lang.String imVersion,
java.lang.String lmoName,
java.lang.String lmoNamespace,
UserInfo userInfo)
Gets the ServiceInvoker for the specified Integration Module.
|
java.util.Map |
getServiceInvoker(java.lang.String ompGUID,
java.lang.String lmoName,
java.lang.String lmoNamespace,
UserInfo userInfo)
Gets the ServiceInvoker for the preferred Integration Module for the specified
Operational Management Product and Logical Management Operation.
|
java.util.Collection |
getServiceInvokerListForCIAndLMO(java.lang.String ciGUID,
java.lang.String lmoName,
java.lang.String lmoNamespace,
UserInfo userInfo)
Gets a list of the ServiceInvokers for the preferred Integration Modules that implement
the specified Logical Management Operation on the Operational Management Products that
have a relationship with the specified Actual Configuration Item.
|
java.lang.String |
getSourceToken(ActCIRemote ci,
OmpRemote omp)
Given an ActCI and an OMP, return the source token that the OMP
uses for the ActCI.
|
java.lang.String |
getSourceToken(java.lang.String ciGUID,
OmpRemote omp)
Given an Actual Configuration Item GUID and an OMP, return the source token that the OMP
uses for the Actual Configuration Item.
|
java.lang.String |
getSourceToken(java.lang.String ciGUID,
java.lang.String ompGUID)
Given an Actual Configuration Item GUID and an Operational Management Product
GUID, return the source token that
the OMP uses for the ActCI.
|
java.lang.String |
getURL(java.lang.String launchEntryName,
OmpRemote omp,
MboRemote mainMbo)
Given a Launch Entry Name, an OMP to launch to, and a main
Mbo for the application, create the launch URL.
|
java.util.Map |
setupEndPoint(java.util.Map<java.lang.String,java.lang.Object> invokerPropMap,
java.lang.String endPointName,
UserInfo userInfo)
Use this method to set or override the Endpoint of a Service Invoker.
|
void |
test()
A simple test method, for development purposes only.
|
checkSecurity, getCriteria, getCurrentState, getLiveObjCount, getMboSet, getName, getSchemaOwner, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, verifyUser, verifyUser
isAppService, isSingletonService, restart
static final int NO_CONTEXT_NEEDED
static final int CORRECT_CONTEXT
static final int INCORRECT_CONTEXT
static final java.lang.String CREDENTIAL_MAPPER_CLASSNAME_PROPERTY
OmpSetRemote getOMPListForLMO(java.lang.String ompProductName, java.lang.String lmoName, java.lang.String lmoNamespace) throws java.rmi.RemoteException, MXException
ompProductName
- Product name of the Operational Management Product to find.lmoName
- Name of the Logical Management Operation.lmoNamespace
- Namespace of the Logical Managment Operation.java.rmi.RemoteException
MXException
- One of the arguments passed on the call is null.OmpSetRemote getOMPListForIM(java.lang.String imName, java.lang.String imVersion) throws java.rmi.RemoteException, MXException
imName
- Integration Module name.imVersion
- Integration Module version.java.rmi.RemoteException
MXException
- One of the arguments passed on the call is null.LMOSetRemote getLMOListForIM(java.lang.String imName, java.lang.String imVersion) throws java.rmi.RemoteException, MXException
imName
- Integration Module name.imVersion
- Integration Module version.java.rmi.RemoteException
MXException
- One of the arguments passed on the call is null.OmpImLmoRelInfo getPreferredIM(java.lang.String ompGUID, java.lang.String lmoName, java.lang.String lmoNamespace) throws java.rmi.RemoteException, MXException
ompGUID
- The OMPGUID of the Operational Management Product.lmoName
- The LMO name.lmoNamespace
- The LMO namespace.java.rmi.RemoteException
MXException
- One of the arguments passed on the call is null.java.util.Collection getIMListForOMPAndLMO(java.lang.String ompGUID, java.lang.String lmoName, java.lang.String lmoNamespace) throws java.rmi.RemoteException, MXException
ompGUID
- The OMPGUID of the Operational Management Product.lmoName
- The LMO name.lmoNamespace
- The LMO namespace.java.rmi.RemoteException
MXException
- One of the arguments passed on the call is null.OmpImLmoRelInfo getPreferredIM(java.lang.String ompHostname, java.lang.String ompProductname, java.lang.String ompManufacturer, java.lang.String lmoName, java.lang.String lmoNamespace) throws java.rmi.RemoteException, MXException
ompHostname
- Hostname of the Operational management Product.ompProductname
- Product name of the Operational Management Product.ompManufacturer
- Manufacturer of the Operational Management Product.lmoName
- LMO name.lmoNamespace
- LMO namespace.java.rmi.RemoteException
MXException
- The ompHostname or ompProductname is null or a matching OMP is not found.java.util.Collection getIMListForOMPAndLMO(java.lang.String ompHostname, java.lang.String ompProductname, java.lang.String ompManufacturer, java.lang.String lmoName, java.lang.String lmoNamespace) throws java.rmi.RemoteException, MXException
ompHostname
- Hostname of the Operational management Product.ompProductname
- Product name of the Operational Management Product.ompManufacturer
- Manufacturer of the Operational Management Product.lmoName
- LMO name.lmoNamespace
- LMO namespace.java.rmi.RemoteException
MXException
- The ompHostname or ompProductname is null or a matching OMP is not found.MaxIMSetRemote getIMListForOMP(java.lang.String ompGuid) throws java.rmi.RemoteException, MXException
ompGuid
- The OMPGUID of the Operational Management Product.java.rmi.RemoteException
MXException
- The ompGuid is null.MaxIMSetRemote getIMListForLMO(java.lang.String lmoName, java.lang.String lmoNamespace) throws java.rmi.RemoteException, MXException
lmoName
- LMO name.lmoNamespace
- LMO namespace.java.rmi.RemoteException
MXException
- One of the arguments passed on the call is null.MaxIMSetRemote getIMListForLMOWithOMP(java.lang.String lmoName, java.lang.String lmoNamespace) throws java.rmi.RemoteException, MXException
lmoName
- LMO name.lmoNamespace
- LMO namespace.java.rmi.RemoteException
MXException
- One of the arguments passed on the call is null.java.util.Collection getServiceInvokerListForCIAndLMO(java.lang.String ciGUID, java.lang.String lmoName, java.lang.String lmoNamespace, UserInfo userInfo) throws java.rmi.RemoteException, MXException
ciGUID
- GUID of the Actual Configuration Item managed by the Operational Management Product.lmoName
- Logical Management Operation name.lmoNamespace
- Logical Management Operation namespace.userInfo
- The UserInfo of the currently logged-in user. You can get it from
mainMbo.getUserInfo().java.rmi.RemoteException
MXException
- One of the arguments passed on the call is null or the
Actual Configuration Item is not management by any Operational Management Product.java.util.Map getServiceInvoker(java.lang.String ompGUID, java.lang.String lmoName, java.lang.String lmoNamespace, UserInfo userInfo) throws java.rmi.RemoteException, MXException
ompGUID
- GUID of the Operational Management Product.lmoName
- Logical Management Operation name.lmoNamespace
- Logical Management Operation namespace.userInfo
- The UserInfo of the currently logged-in user. You can get it from
mainMbo.getUserInfo().java.rmi.RemoteException
MXException
- One of the arguments passed on the call is null.java.util.Map getServiceInvoker(OmpImLmoRelRemote ompImLmoRelRemote, UserInfo userInfo) throws java.rmi.RemoteException, MXException
ompImLmoRelRemote
- An OmpImLmoRelRemote representing a specific IM that implements a specific LMO on a specific OMP.userInfo
- The UserInfo of the currently logged-in user. You can get it from
mainMbo.getUserInfo().java.rmi.RemoteException
MXException
- The userInfo is null.java.util.Map getServiceInvoker(java.lang.String ompGUID, java.lang.String imName, java.lang.String imVersion, java.lang.String lmoName, java.lang.String lmoNamespace, UserInfo userInfo) throws java.rmi.RemoteException, MXException
ompGUID
- GUID of the Operational Management Product.imName
- Integration Module name.imVersion
- Integration Module version.lmoName
- Logical Management Operation name.lmoNamespace
- Logical Management Operation namespace.userInfo
- The UserInfo of the currently logged-in user. You can get it from
mainMbo.getUserInfo().java.rmi.RemoteException
MXException
- One of the arguments passed on the call is null.java.util.Map getServiceInvoker(OmpImLmoRelInfo ompImLmoRelInfo, UserInfo userInfo) throws java.rmi.RemoteException, MXException
ompImLmoRelInfo
- An OmpImLmoRelRemote representing a specific IM that implements a specific LMO on a specific OMP.userInfo
- The UserInfo of the currently logged-in user. You can get it from
mainMbo.getUserInfo().java.rmi.RemoteException
MXException
- The userInfo is null.BaseCredentialMapper getCredentialMapper(UserInfo userInfo, java.lang.String endPointName) throws MXException, java.rmi.RemoteException
userInfo
- The currently logged-in user (be sure not to use the system user).endPointName
- The name of the end point to use.MXApplicationException
- The credential mapper classname is not found in the
classpath, or the constructor for the class is not found, or the class cannot
be instantiated or used.java.rmi.RemoteException
MXException
java.util.Map setupEndPoint(java.util.Map<java.lang.String,java.lang.Object> invokerPropMap, java.lang.String endPointName, UserInfo userInfo) throws MXException, java.rmi.RemoteException
invokerPropMap
- The Service Invoker Map containing the JavaIM or InvokeChannel
object, IM Name, IM Version, LMO Name, LMO Namespace, OMP guid, Endpoint name,
and Endpoint properties.endPointName
- The name of the new endpoint.userInfo
- The UserInfo of the currently logged-in user. You can get it from
mainMbo.getUserInfo().MXException
java.rmi.RemoteException
LMOSetRemote getLMOsNotAssociatedWithIM(MboRemote imMbo) throws java.rmi.RemoteException, MXException
imMbo
- - Integration Module.java.rmi.RemoteException
MXException
- The imMbo is null.LMOSetRemote getLMOListForOMP(java.lang.String ompGuid) throws java.rmi.RemoteException, MXException
ompGuid
- Operational Management Product GUID.java.rmi.RemoteException
MXException
- The ompGuid is null.void test() throws MXException, java.rmi.RemoteException
MXException
java.rmi.RemoteException
java.lang.String getURL(java.lang.String launchEntryName, OmpRemote omp, MboRemote mainMbo) throws java.rmi.RemoteException, MXException
launchEntryName
- The name of the launch entry.omp
- The OMP to launch to (null if this is not an OMP-type launch entry).mainMbo
- The main MBO for the application.MXApplicationException
- The launch entry with the given name is not found.MXApplicationException
- One of the substituted values cannot be URL-encoded.MXException
- There is a substitution variables in the launch entry's
console URL that cannot be substituted from the main MBO.java.rmi.RemoteException
OmpSetRemote getOMPList(java.lang.String launchEntryName, MboRemote mainMbo) throws java.rmi.RemoteException, MXException
launchEntryName
- The name of the launch entry to use.mainMbo
- The main MBO of the current application.MXApplicationException
- The launch entry with the given name is not found.MXApplicationException
- This is not a MBO with a CI GUID, but the Launch
Entry requires OMPs (it has an OMP product name).MXApplicationException
- There is an error when getting the CI GUID attribute.java.rmi.RemoteException
MXException
java.lang.String getSourceToken(java.lang.String ciGUID, java.lang.String ompGUID) throws java.rmi.RemoteException, MXException
ciGUID
- The Actual Configuration Item GUID to use.ompGUID
- The Operational Management Product GUID to use.MXApplicationException
- The OMP with this GUID is not found.MXApplicationException
- The ActCI with this GUID is not found.java.rmi.RemoteException
MXException
java.lang.String getSourceToken(java.lang.String ciGUID, OmpRemote omp) throws java.rmi.RemoteException, MXException
ciGUID
- The Actual Configuration Item GUID to use.omp
- The OMP to use.MXApplicationException
- The ActCI with this GUID is not found.java.rmi.RemoteException
MXException
java.lang.String getSourceToken(ActCIRemote ci, OmpRemote omp) throws java.rmi.RemoteException, MXException
ci
- The ActCI to use.omp
- The OMP to use.java.rmi.RemoteException
MXException
MaxLaunchEntryInfo getLaunchEntry(java.lang.String launchEntryName) throws MXException, java.rmi.RemoteException
launchEntryName
- The name of the launch entry to look up.MXException
java.rmi.RemoteException
int checkContext(MaxLaunchEntryInfo entry, MboRemote mainMbo) throws java.rmi.RemoteException, MXException
entry
- The launch entry to check (must not be null).mainMbo
- The main MBO for the application.MXApplicationException
- The main MBO has a classstructureid attribute,
but there was an error in reading it.MXApplicationException
- The launch entry is null.java.rmi.RemoteException
MXException
LMOSetRemote getLMOsNotAssociatedWithIMAndOmp(MboRemote ompImRel) throws MXException, java.rmi.RemoteException
ompImRel
- - OmpImRel with the IM and OMP of interest.MXApplicationException
- The OmpImRel is null.MXApplicationException
- The IM does not exist.MXException
java.rmi.RemoteException
java.lang.String getCIGUIDFromMBO(MboRemote mainMbo) throws java.rmi.RemoteException, MXException
mainMbo
- The MBO to try to get the CI GUID from. Must not be null.MXApplicationException
- The GUID or CIGUID attribute is present
in the MBO, but calling getString on it fails.java.rmi.RemoteException
MXException