Index Changes

Difference between version and version     

Back to IEP Monitor And Debug, or IEP Monitor And Debug Info


At line 5 changed 1 line.
!!! IEP Administration.
!!! IEP Administration
At line 8 added 1 line.
At line 8 changed 9 lines.
\\
IEP Administration services provides a way to access IEP service engine at runtime. It enables user to access information about, debug and modify a deployed process.
\\
It is a part Systemic qualities efforts. A collection of MBeans that interacts with IEP service engine and an IEP Management Services that exposes calls to these beans through a simple java API.
\\
\\
\\
The following is the the list of actions that can be performed using IEP Management Services.
\\
IEP Administration services provides a way to access the IEP service engine at runtime. It enables user to access information about, debug and modify a deployed process.
It is a part of Systemic qualities efforts. A collection of MBeans that interacts with IEP service engine and an IEP Management Services that exposes calls to these beans through a simple Java API.
The following actions can be performed using IEP Management Services.
At line 20 changed 1 line.
** Get the list of Attributes, of an Operator in a deployed IEP process, exposed by IEP Service Engine.
** Get the list of Attributes, of an operator in a deployed IEP process, exposed by IEP Service Engine.
At line 23 changed 1 line.
** Attach a Step by Step debugger to an IEP process.
** Attach a step by step debugger to an IEP process.
At line 25 changed 2 lines.
** Get current debug info available with debugger for any operator.
** Detach the Step by Step debugger from an IEP process.
** Get current debug information available with debugger for any operator.
** Detach the step by step debugger from an IEP process.
At line 28 changed 1 line.
* __Runtime modification to IEP Engine.__
* __Runtime modification to IEP Engine__
At line 31 changed 1 line.
** Add a Save Stream for an Input Stream operator.
** Add a Save Stream operator for an Input Stream operator.
At line 33 changed 1 line.
\\
** Change operator properties. (Currently, only the WHERE clause of the Stream Projection And Filter operator can be modified.) For more information, see [Changing the Properties of an IEP Operator at Runtime|IEPChangeOperatorProp].
At line 35 added 1 line.
----
At line 37 changed 1 line.
\\
At line 39 changed 1 line.
* Admin service APIs this can be downloaded from here [IEPManagement API | IEPManagementService.jar]
* Admin service APIs. These can be downloaded from [IEPManagementService.jar]
** With complete source [IEPManagementService.zip]
At line 41 changed 5 lines.
** With complete source code. [IEP Management Client|IEPManagement.zip].
** Just the runnable jar file. [IEPManagement.jar]
\\
\\
!! How to use
** With complete source code. [IEPManagement.zip].
** Just the jar file. [IEPManagement.jar]
----
!! How To Use
At line 49 changed 1 line.
* Download the IEPManagementService.jar file from above mentioned location.
* Download the IEPManagementService.jar file from the above mentioned location.
At line 51 changed 2 lines.
**If you have downloaded the project with complete source code, open the project in Netbeans , add the IEPManagementServices.jar file to the project class path if it is not added already.
** Add jbi-admin-common.jar to the class path as well. The usual location of this jar file is at {{GlassFish Installation dir\jbi\lib}}
** If you downloaded the project with complete source code, open the project in NetBeans, add the IEPManagementServices.jar file to the project class path if it is not added already.
** Add jbi-admin-common.jar to the class path as well. The usual location of this jar file is {{GlassFish-installation-dir\jbi\lib}}
At line 54 changed 5 lines.
* If you have downloaded just the runnable jar file, add the IEPManagement.jar,IEPManagementServices.jar and jbi-admin-common.jar from {{GlassFish Installation dir\jbi\lib}} to class path and use following command to start the client console.
\\
%%center
__''java com.sun.esb.management.client.tester.IEPManagementSample''__%%
* If you downloaded just the runnable jar file, add the IEPManagement.jar, IEPManagementServices.jar and jbi-admin-common.jar from {{GlassFish Installation dir\jbi\lib}} to class path and use the following command to start the client console.
At line 60 changed 5 lines.
\\
To get the list of available commands and the required parameters simply type ''h'' or ''help ''on the console or see the section about [command line client| http://wiki.open-esb.java.net/Wiki.jsp?page=IEPMonitorAndDebug#section-IEPMonitorAndDebug-IEPManagementServicesClient]
\\
\\
! IEP Management API or build custom client.
{{{
java com.sun.esb.management.client.tester.IEPManagementSample
}}}
At line 66 changed 6 lines.
IEP Management API is a wrapper around MBean calls to Administration bean in IEP Service engine. If you are planing to create your own client application using the APIs, add this jar file and jbi-admin-common.jar from <GlassFish Installation>\jbi\lib to your project class path. The [IEP Management Client|IEPManagement.zip] can be used as reference implementation.
\\
For detailed description about the APIs please look at [APIs | http://wiki.open-esb.java.net/Wiki.jsp?page=IEPMonitorAndDebug#section-IEPMonitorAndDebug-IEPAdministrationServices].
\\
\\
!! Component Descriptions
To get the list of available commands and the required parameters, type ''h'' or ''help'' on the console, or see the [IEP Management Services Client | http://wiki.open-esb.java.net/Wiki.jsp?page=IEPMonitorAndDebug#section-IEPMonitorAndDebug-IEPManagementServicesClient] section.
! IEP Management API or build custom client
IEP Management API is a wrapper around MBean calls to Administration bean in IEP Service Engine. If you plan to create your own client application using the APIs, then add this jar file and jbi-admin-common.jar from <GlassFish Installation>\jbi\lib to your project class path. The [IEP Management Client|IEPManagement.zip] can be used as reference implementation.
For detailed description about the APIs, see the [IEP Administration Services | http://wiki.open-esb.java.net/Wiki.jsp?page=IEPMonitorAndDebug#section-IEPMonitorAndDebug-IEPAdministrationServices] section.
At line 76 added 2 lines.
!! Component Descriptions
At line 75 removed 7 lines.
\\
The sample command line client uses the management services to execute methods on administration beans.By default it connects to localhost 8686 using admin as userID and adminadmin as password.To change use ''connect ''command.
\\
to run the client simply call
\\
%%center
''java com.sun.esb.management.client.tester.IEPManagementSample''%%
At line 83 changed 1 line.
\\
The sample command line client uses the management services to execute methods on administration beans. By default, it connects to localhost 8686 using {{admin}} as the userID and {{adminadmin}} as the password. To change, use the __connect__ command.
At line 82 added 8 lines.
To run the client, call:
{{{
java com.sun.esb.management.client.tester.IEPManagementSample
}}}
Entering __h__ or __help__ will print the available commands and their parameters:
At line 86 changed 1 line.
h or help will print the available commands and the parameters as listed below
__h, help__: Prints this.
At line 88 changed 1 line.
__h, help__: Prints this.
__q, quit__: Quit
At line 90 changed 1 line.
__q, quit__: Quit
__connect__ __''host port userID password''__: Connect to management bean server. Default values are localhost 8686 admin adminadmin
At line 92 changed 1 line.
__connect__ __''host port userID password''__: Connects to management bean server.Default is localhost 8686 admin adminadmin
__li, listIEP__ __''service_unit_name''__ : List IEP process deployed in a service unit. service_unit_name is the name of IEP unit that is deployed in jbi. Look for screen capture below to locate it in NetBeans server configuration. If no service unit name is provided, the command will list all deployed IEP plans.
At line 94 changed 1 line.
__li, listIEP__ __''service_unit_name''__ : List IEP process deployed in a Service unit. service_unit_name is the name of IEP unit that is deployed in jbi. Look for figure below to locate it in Netbeans server configuration.If no service unit name is provided, the command will list all deployed IEP plans.
__d, debug__ __''plan_name'' __ : Debug an IEP process. The plan_name can be found using listIEP command. For more information, see the [IEP Debugging section| http://wiki.open-esb.java.net/Wiki.jsp?page=IEPMonitorAndDebug#section-IEPMonitorAndDebug-IEPDebugging].
At line 96 changed 1 line.
__d, debug__ __''plan_name'' __ : Debug an IEP process. The plan_name can be found using listIEP command. Refer [IEP Debugging section| http://wiki.open-esb.java.net/Wiki.jsp?page=IEPMonitorAndDebug#section-IEPMonitorAndDebug-IEPDebugging] for more information.
__lo, listOperators__ __''plan_name''__ : List operators in an IEP process. The plan_name can be found by using the listIEP command.
At line 98 changed 1 line.
__lo, listOperators__ __''plan_name''__ : List operators in an IEP process. The plan_name can be found using listIEP command.
__la, listAttributes__ __''plan_name operator_name''__ : List visible properties of an operator. The operator_name can be found by using the listOperators command.
At line 100 changed 1 line.
__la, listAttributes__ __''plan_name operator_name''__ : List visible properties of an Operator. operator_name can be found by using listOperators command.
__scs, startChangeSet__ : informs the IEP engine that a new change set request has been initiated. Refer [Changing the Properties of an IEP Operator at Runtime|IEPChangeOperatorProp].
At line 102 changed 1 line.
__cpv, changePropValue__ __''plan_name operator_name attribute_key attribute_value''__ : Sets the value of a property.
__acs, applyChangeSet__ : informs the IEP engine to schedule all the changes done by using changePropValue,cpv to be applied and persisted. After this for any further changes startChangeSet,scs must be called first. Refer [Changing the Properties of an IEP Operator at Runtime|IEPChangeOperatorProp].
At line 104 changed 1 line.
__eda, enableDA __ __''plan_name operator_name table_name'' __ : Enable Data Access for an operator into a table. Refer Data Access wiki entry for more information.
__ics, ignoreChangeSet__ : informs the IEP engine to ignore the change set. After this for any further changes startChangeSet,scs must be called first. Refer [Changing the Properties of an IEP Operator at Runtime|IEPChangeOperatorProp].
At line 106 changed 1 line.
__addss ,addSaveStream__ __''plan_name operator_name jndi_name tableName'' __ : Add a save stream to an input stream operator. Refer Save Stream for more information. Returns the name of the Save Stream operator that gets added through this command.
__cpv, changePropValue__ __''plan_name operator_name attribute_key attribute_value''__ : Set the value of a property. Refer [Changing the Properties of an IEP Operator at Runtime|IEPChangeOperatorProp].
At line 108 changed 1 line.
__rss ,removeSaveStream__ __''plan_name save_operaor_name'' __ : Removes the save stream operator. save_operator_name is the name that gets returned by addSaveStream operator.
__eda, enableDA __ __''plan_name operator_name table_name'' __ : Enable Data Access for an operator into a table. For more information, refer Data Access wiki entry.
At line 115 added 4 lines.
__addss, addSaveStream__ __''plan_name operator_name jndi_name tableName'' __ : Add a save stream to an input stream operator. For more information, refer Save Stream. Returns the name of the Save Stream operator that is added.
__rss, removeSaveStream__ __''plan_name save_operator_name'' __ : Remove the save stream operator. The save_operator_name is the name that gets returned by the addSaveStream operator.
At line 111 removed 6 lines.
\\
\\
%%center
How to find the unit name for listIEP command
\\
[{Image src='plan_name.PNG' width='' height='' align='left|center|right' }]%%
At line 121 added 1 line.
You can find the service unit name for the __listIEP__ command in the Services window of the IDE. Expand the Servers node, the GlassFish V2 node, the JBI node, the Service Assemblies node, and the individual service assembly node. See the following screen capture.
At line 119 changed 3 lines.
\\
\\
----
[{Image src='plan_name.PNG' width='' height='' align='left|center|right' }]
At line 127 added 1 line.
[API listing] describes all the methods that are available with the latest IEP Service Engine.
At line 125 changed 7 lines.
The [API listing] describes all the methods that are available with latest IEP SE.
\\
\\
To get a handle to IEPMangementService use
%%center
{{IEPManagementServiceFactory.createNewServiceInstance(_MBeanServerConnection_object);}}%%
\\
To get a handle to IEPManagementService, use:
At line 133 changed 1 line.
MBeanServerConnection can be obtained in many ways one is described below
{{{
IEPManagementServiceFactory.createNewServiceInstance(_MBeanServerConnection_object);
}}}
At line 135 added 2 lines.
MBeanServerConnection can be obtained in many ways. One way is shown below.
At line 136 changed 10 lines.
public static MBeanServerConnection getMBeanServerConnection(
String urlString, String userName, String password)
throws MalformedURLException, IOException {
final JMXServiceURL url = new JMXServiceURL(urlString);
String[] credentials = new String[] { userName, password };
Map<String, String[]> environment = new HashMap<String, String[]>();
environment.put("jmx.remote.credentials", credentials);
final JMXConnector connector = JMXConnectorFactory.connect(url,
environment);
return connector.getMBeanServerConnection();
public static MBeanServerConnection getMBeanServerConnection(
String urlString, String userName, String password)
throws MalformedURLException, IOException {
At line 142 added 7 lines.
final JMXServiceURL url = new JMXServiceURL(urlString);
String[] credentials = new String[] { userName, password };
Map<String, String[]> environment = new HashMap<String, String[]>();
environment.put("jmx.remote.credentials", credentials);
final JMXConnector connector = JMXConnectorFactory.connect(url, environment);
return connector.getMBeanServerConnection();
At line 150 added 1 line.
At line 149 removed 1 line.
{{{
At line 153 added 1 line.
{{{
At line 153 changed 3 lines.
\\
\\
----
At line 158 changed 3 lines.
There is a step by step IEP processor to facilitate some debugging for IEP enigne. \\
The idea is to execute process in a per operator basis and let user control the flow. At every point of execution user can get information related to any operator and it's current state of data(events).
\\
There is a step by step IEP processor to facilitate some debugging for the IEP engine. The idea is to execute process in a per operator basis and let user control the flow. At every point of execution, user can get information related to any operator and its current state of data(events).
At line 161 added 1 line.
The steps are:
At line 163 changed 4 lines.
The steps are
*1. Call IEP Management services and set an IEP process for debugging by
**a. calling ''setIEPForDebugging(mPlanName);''. This will let IEP engine know to attach a StepByStep processor to the process(plan).
**b. or start the debug console using command line IEP Management Services Client use the command __d, debug__ {''plan_name''}
1. Call IEP Management services and set an IEP process for debugging by
At line 168 changed 3 lines.
*2. Once an IEP process is attached to StepByStep processor user can execute debug commands by sending those commands through management services.
\\
So far the list of commands that can be executed are listed below
a. calling ''setIEPForDebugging(mPlanName);''. This will let the IEP engine know to attach a step by step processor to the process(plan).
At line 172 changed 1 line.
b. or start the debug console using command line IEP Management Services Client use the command __d, debug__ {''plan_name''}
2. Once an IEP process is attached to the step by step processor, user can execute debug commands by sending those commands through management services.
The list of debug commands that can be executed are:
At line 174 removed 1 line.
__next __: execute next available operator.
At line 175 added 1 line.
__help,h__ : Help on available commands.
At line 177 changed 1 line.
__completeCycle __: completes one cycle of IEP process .
__quit,q__ : Quit the debug session and detach step by step processor.
At line 179 added 1 line.
__next,n__ : execute next available operator.
At line 180 changed 1 line.
__nextCompleteCycles ''noOfTime(int)'' __: complete cycles of IEP process ''noOfTime ''times.
__completeCycle,cc__ : complete one cycle of IEP process.
At line 183 added 1 line.
__nextCompleteCycles,ncc ''noOfTime(int)''__ : complete cycles of IEP process ''noOfTime'' times.
At line 183 changed 1 line.
__nextCompleteCyclesForTimePeriod ''milliseconds (long)''__ : complete the cycles of IEP process for ''milliseconds ''time.
__nextCompleteCyclesForTimePeriod,nct ''milliseconds (long)''__ : complete cycles of IEP process for ''milliseconds'' time.
At line 187 added 1 line.
__addPauseBefore,apb ''operatorName''__ : add a pause (breakpoint) before an IEP process.
At line 186 changed 1 line.
__addPauseBefore ''operatorName''__ : add a pause (breakpoint) before an IEP process.
__nextTillPause,ntp__ : execute IEP process till a pause is found or cycle is complete.
At line 188 changed 1 line.
__nextTillPause __ : execute iep process till a pause is found or cycle is complete.
__nextOperator,no__ : display the name of the operator that is to be executed next.
At line 190 changed 1 line.
__nextOperator__ : displays the name of the operator that is to be executed next.
__removePauseBefore,rpb ''operatorName''__ : remove the pause before the operator if there is one available.
At line 192 changed 1 line.
__removePauseBefore ''operatorName''__ : removes the pause before the operator if there is one available.
__listOperators,lo__ : List operator names in sequence of execution.It appends a '**' in front of operator names that are yet to be executed.
At line 194 changed 1 line.
__info__ : shows the relevent information about the last executed operator.
__listOperatorProperties,lop ''operatorName''__ : List all the properties associated with an operator.If operatorName is not provided the default will be used which is the last executed operator.
At line 196 changed 1 line.
__info ''oprName''__ : shows the debug information about the ''oprName ''operator.%%
__info,i__ : show the relevant information about the last executed operator.
At line 201 added 1 line.
__info,i ''operatorName''__ : show the debug information about the ''operatorName'' operator.%%
At line 204 added 2 lines.
----
[Go to IEP Wiki Home|IEPSE]
At line 202 removed 2 lines.
\\

JSPWiki v2.4.100
[RSS]
« Home Index Changes Prefs
This page (revision-58) was last changed on 18-Nov-08 12:30 PM, -0800 by Jeff Stein