psdi.iface.mic

Interface MicServiceRemote

All Superinterfaces:

AppServiceRemote, java.rmi.Remote, ServiceRemote

All Known Implementing Classes:

EntMicService, MicService

public interface MicServiceRemote
extends AppServiceRemote

Remote Interface to the MicService object.

Version:

1.0

Author:

Boris Dozortsev

Method Summary

Modifier and Type	Method and Description
int	deleteQueueData(java.lang.String queueName, java.lang.String selector, int count, UserInfo userInfo) This method will be called from outside to view the messages in a JMS Queue
void	exportData(java.lang.String interfaceName, java.lang.String sender, java.lang.String where, UserInfo userInfo, int maxcount) This method will be called from GUI for bulk data loading from MAXIMO to external system
void	generateMOSServiceSchema(java.lang.String mosName, boolean forceGenerate)
MosInfo	getObjectStructureInfo(java.lang.String objectStructureName) Get MosInfo for a given Object Structure name.
byte[]	loadData(byte[] in, UserInfo info, MXTransaction trans, java.util.Map defaults) This method will be called to load Object Structure XML data.
void	loadSystemData(java.lang.String directory, java.lang.String intLevel, UserInfo userInfo) Process system data comimg from external system.
byte[]	processExternalData(byte[] data, java.lang.String sender, java.lang.String serviceName, UserInfo info, MXTransaction trans) Process data comimg from external system.
void	processJMSRecovery(java.lang.String queueName, UserInfo userInfo)
byte[]	processObjectStructureService(byte[] in, java.lang.String mosName, java.lang.String messageType, UserInfo info, MXTransaction trans) This method will be called for every MOS to process External data.
byte[]	query(byte[] queryXml, java.lang.String serviceName, java.lang.String extSystem, UserInfo userInfo) Query maximo via query query services.
byte[]	query(byte[] queryXml, java.lang.String mosName, UserInfo userInfo) Query maximo via query objec structure service.
void	restart() This method will be called from outside to reload some objects
byte[]	routeData(byte[] data, java.lang.String endPointName, java.util.Map<java.lang.String,?> metaData) Deplyment manager API to Route Data.
void	tryObjectStructure(java.lang.String mosName, java.lang.String where, UserInfo userInfo)
void	viewQueueData(java.lang.String queueName, java.lang.String selector, int count, UserInfo userInfo) This method will be called from outside to view the messages in a JMS Queue
int	viewQueueData(java.lang.String queueName, java.lang.String selector, int count, UserInfo userInfo, boolean countOnly)
int	viewQueueData(java.lang.String queueName, java.lang.String selector, int count, UserInfo userInfo, boolean countOnly, java.util.List<java.lang.String> viewFilesList)

Methods inherited from interface psdi.server.AppServiceRemote

checkSecurity, getCriteria, getCurrentState, getLiveObjCount, getMboSet, getName, getSchemaOwner, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, verifyUser, verifyUser

Methods inherited from interface psdi.server.ServiceRemote

isAppService, isSingletonService

Method Detail

viewQueueData

int viewQueueData(java.lang.String queueName,
                  java.lang.String selector,
                  int count,
                  UserInfo userInfo,
                  boolean countOnly,
                  java.util.List<java.lang.String> viewFilesList)
           throws java.rmi.RemoteException,
                  MXException

Throws:

java.rmi.RemoteException

MXException

viewQueueData

int viewQueueData(java.lang.String queueName,
                  java.lang.String selector,
                  int count,
                  UserInfo userInfo,
                  boolean countOnly)
           throws java.rmi.RemoteException,
                  MXException

Throws:

java.rmi.RemoteException

MXException

deleteQueueData

int deleteQueueData(java.lang.String queueName,
                    java.lang.String selector,
                    int count,
                    UserInfo userInfo)
             throws java.rmi.RemoteException,
                    MXException

This method will be called from outside to view the messages in a JMS Queue

Parameters:

queueName - -the JNDI name of the Queue

selector - -the selector for the Queue

count - -the count of messages to be deleted.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

viewQueueData

void viewQueueData(java.lang.String queueName,
                   java.lang.String selector,
                   int count,
                   UserInfo userInfo)
            throws java.rmi.RemoteException,
                   MXException

This method will be called from outside to view the messages in a JMS Queue

Parameters:

queueName - -the JNDI name of the Queue

selector - -the selector for the Queue

count - -the count of messages to be viewed.

userInfo - -the User Info object.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

restart

void restart()
      throws java.rmi.RemoteException

This method will be called from outside to reload some objects

Specified by:

restart in interface ServiceRemote

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

tryObjectStructure

void tryObjectStructure(java.lang.String mosName,
                        java.lang.String where,
                        UserInfo userInfo)
                 throws MXException,
                        java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

routeData

byte[] routeData(byte[] data,
                 java.lang.String endPointName,
                 java.util.Map<java.lang.String,?> metaData)
          throws MXException,
                 java.rmi.RemoteException

Deplyment manager API to Route Data.

Parameters:

data - byte repersentataion of the data

endPointName - name of the end point

metaData - Map of parameters

Throws:

java.rmi.RemoteException

MXException

processObjectStructureService

byte[] processObjectStructureService(byte[] in,
                                     java.lang.String mosName,
                                     java.lang.String messageType,
                                     UserInfo info,
                                     MXTransaction trans)
                              throws MXException,
                                     java.rmi.RemoteException

This method will be called for every MOS to process External data.

Parameters:

in - Give byteArray

mosName - Give name of MOS.

messageType - Give name of operation.

info - Give reference to UserInfo object.

trans - Give MXTransaction object.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

loadSystemData

void loadSystemData(java.lang.String directory,
                    java.lang.String intLevel,
                    UserInfo userInfo)
             throws MXException,
                    java.rmi.RemoteException

Process system data comimg from external system. THis method can be used for installation of adapter or patches

Parameters:

directory - Give directory where load files are

intLevel - Lervel of processing.

userInfo - the user details for security validation

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

loadData

byte[] loadData(byte[] in,
                UserInfo info,
                MXTransaction trans,
                java.util.Map defaults)
         throws MXException,
                java.rmi.RemoteException

This method will be called to load Object Structure XML data.

Parameters:

in - Give byteArray

info - Give reference to UserInfo object.

trans - Give MXTransaction object.

defaults - Map of defult values to skip setting data to Mbo from XML.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

processExternalData

byte[] processExternalData(byte[] data,
                           java.lang.String sender,
                           java.lang.String serviceName,
                           UserInfo info,
                           MXTransaction trans)
                    throws MXException,
                           java.rmi.RemoteException

Process data comimg from external system. This is remote method for transaction going without queue

Parameters:

data - Give data as byte array

sender - Give sender name.

ifaceName - Give name of interface.

info - Give reference to UserInfo object.

trans - Give MXTransaction object.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

exportData

void exportData(java.lang.String interfaceName,
                java.lang.String sender,
                java.lang.String where,
                UserInfo userInfo,
                int maxcount)
         throws MXException,
                java.rmi.RemoteException

This method will be called from GUI for bulk data loading from MAXIMO to external system

Parameters:

interfaceName - Give name of interface.

sender - Give external system name.

where - Give where clause.

userInfo - Give reference to UserInfo object.

maxcount - maximum count to get.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

query

byte[] query(byte[] queryXml,
             java.lang.String serviceName,
             java.lang.String extSystem,
             UserInfo userInfo)
      throws MXException,
             java.rmi.RemoteException

Query maximo via query query services. Returns response in XML format.

Parameters:

queryXml - the query xml in byte[] format

serviceName - name of the service

extSystem - name of the external system

userInfo - the UserInfo for user details

Returns:

the response xml as a byte[]

Throws:

java.rmi.RemoteException

MXException

query

byte[] query(byte[] queryXml,
             java.lang.String mosName,
             UserInfo userInfo)
      throws MXException,
             java.rmi.RemoteException

Query maximo via query objec structure service. Returns response in XML format.

Parameters:

queryXml - the query xml

mosName - the object structure name

userInfo - the UserInfo for user details

Returns:

the response xml as a byte[]

Throws:

java.rmi.RemoteException

MXException

processJMSRecovery

void processJMSRecovery(java.lang.String queueName,
                        UserInfo userInfo)
                 throws java.rmi.RemoteException,
                        MXException

Throws:

java.rmi.RemoteException

MXException

generateMOSServiceSchema

void generateMOSServiceSchema(java.lang.String mosName,
                              boolean forceGenerate)
                       throws java.rmi.RemoteException,
                              MXException

Throws:

java.rmi.RemoteException

MXException

getObjectStructureInfo

MosInfo getObjectStructureInfo(java.lang.String objectStructureName)
                        throws java.rmi.RemoteException

Get MosInfo for a given Object Structure name.

Returns:

MosInfo object

Throws:

java.rmi.RemoteException