com.bmc.arsys.plugin.sample

Class ARDBCSample

java.lang.Object

com.bmc.arsys.pluginsvr.plugins.ARPlugin

com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

com.bmc.arsys.plugin.sample.ARDBCSample

All Implemented Interfaces:

com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable, com.bmc.arsys.pluginsvr.plugins.ARPluggable

public class ARDBCSample
extends com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

A sample ARDBC plugin implementation as an example of how to use the sdk. This plugin extends ARDBCPlugin object. Alternatively, one could implement the interface ARDBCPluggable. This implementation fetches the jdbc connection information as config items using the plugin context. Uses that information to establish a jdbc connection to a SQL Server database. Provides a way of creating vendor forms using tables in the underlying database.

Constructor Summary

Constructors

Constructor and Description
ARDBCSample() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	cancel(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context, long transid)
void	commit(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context, long transid)
String	createEntry(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context, String tableName, List<com.bmc.arsys.pluginsvr.plugins.ARVendorField> fields, long transid, com.bmc.arsys.api.Entry newEntry)
void	deleteEntry(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context, String tableName, List<com.bmc.arsys.pluginsvr.plugins.ARVendorField> fields, long transid, String entryId)
com.bmc.arsys.api.AttachmentValue	getBLOB(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context, String tableName, List<com.bmc.arsys.pluginsvr.plugins.ARVendorField> fields, long transid, String entryId, int fieldId)
com.bmc.arsys.api.Entry	getEntry(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context, String tableName, List<com.bmc.arsys.pluginsvr.plugins.ARVendorField> fields, long transid, String entryId, int[] fieldIds)
List<com.bmc.arsys.api.StatisticsResultInfo>	getEntryStatistics(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context, String tableName, List<com.bmc.arsys.pluginsvr.plugins.ARVendorField> fields, long transid, com.bmc.arsys.api.QualifierInfo qual, com.bmc.arsys.api.ArithmeticOrRelationalOperand arithOp, int statistic, int[] groupBy)
List<com.bmc.arsys.api.Entry>	getListEntryWithFields(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context, String tableName, List<com.bmc.arsys.pluginsvr.plugins.ARVendorField> fields, long transid, com.bmc.arsys.api.QualifierInfo qual, List<com.bmc.arsys.api.SortInfo> sortList, List<com.bmc.arsys.api.EntryListFieldInfo> fieldList, int startAt, int maxReturn, com.bmc.arsys.api.OutputInteger numMatches)
List<com.bmc.arsys.api.VendorForm>	getListForms(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context)
List<com.bmc.arsys.pluginsvr.plugins.ARVendorField>	getMultipleFields(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context, com.bmc.arsys.api.VendorForm form)
void	initialize(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context)
void	onEvent(com.bmc.arsys.pluginsvr.plugins.ARPluginContext contexxt, int eventId)
void	rollback(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context, long transid)
void	setBLOB(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context, String tableName, List<com.bmc.arsys.pluginsvr.plugins.ARVendorField> fields, long transid, String entryId, int fieldId, com.bmc.arsys.api.AttachmentValue blob)
void	setEntry(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context, String tableName, List<com.bmc.arsys.pluginsvr.plugins.ARVendorField> fields, long transid, String entryId, com.bmc.arsys.api.Entry entry, com.bmc.arsys.api.Timestamp lastModified)
void	terminate(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context)

Methods inherited from class java.lang.Object

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

Constructor Detail

ARDBCSample

public ARDBCSample()

Default constructor. Could as well do whatever is done in initialize. But as a default constructor, this will not have access to ARPluginContext object. In cases where that information is needed, better to do any initializations in initialize()

Method Detail

cancel

public void cancel(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context,
                   long transid)
            throws com.bmc.arsys.api.ARException

Specified by:

cancel in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Overrides:

cancel in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

Throws:

com.bmc.arsys.api.ARException

commit

public void commit(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context,
                   long transid)
            throws com.bmc.arsys.api.ARException

Specified by:

commit in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Overrides:

commit in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

Throws:

com.bmc.arsys.api.ARException

createEntry

public String createEntry(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context,
                          String tableName,
                          List<com.bmc.arsys.pluginsvr.plugins.ARVendorField> fields,
                          long transid,
                          com.bmc.arsys.api.Entry newEntry)
                   throws com.bmc.arsys.api.ARException

Specified by:

createEntry in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Overrides:

createEntry in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

Throws:

com.bmc.arsys.api.ARException

deleteEntry

public void deleteEntry(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context,
                        String tableName,
                        List<com.bmc.arsys.pluginsvr.plugins.ARVendorField> fields,
                        long transid,
                        String entryId)
                 throws com.bmc.arsys.api.ARException

Specified by:

deleteEntry in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Overrides:

deleteEntry in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

Throws:

com.bmc.arsys.api.ARException

getBLOB

public com.bmc.arsys.api.AttachmentValue getBLOB(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context,
                                                 String tableName,
                                                 List<com.bmc.arsys.pluginsvr.plugins.ARVendorField> fields,
                                                 long transid,
                                                 String entryId,
                                                 int fieldId)
                                          throws com.bmc.arsys.api.ARException

Specified by:

getBLOB in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Overrides:

getBLOB in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

Throws:

com.bmc.arsys.api.ARException

getEntry

public com.bmc.arsys.api.Entry getEntry(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context,
                                        String tableName,
                                        List<com.bmc.arsys.pluginsvr.plugins.ARVendorField> fields,
                                        long transid,
                                        String entryId,
                                        int[] fieldIds)
                                 throws com.bmc.arsys.api.ARException

Specified by:

getEntry in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Overrides:

getEntry in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

Throws:

com.bmc.arsys.api.ARException

getEntryStatistics

public List<com.bmc.arsys.api.StatisticsResultInfo> getEntryStatistics(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context,
                                                                       String tableName,
                                                                       List<com.bmc.arsys.pluginsvr.plugins.ARVendorField> fields,
                                                                       long transid,
                                                                       com.bmc.arsys.api.QualifierInfo qual,
                                                                       com.bmc.arsys.api.ArithmeticOrRelationalOperand arithOp,
                                                                       int statistic,
                                                                       int[] groupBy)
                                                                throws com.bmc.arsys.api.ARException

Specified by:

getEntryStatistics in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Overrides:

getEntryStatistics in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

Throws:

com.bmc.arsys.api.ARException

getListEntryWithFields

public List<com.bmc.arsys.api.Entry> getListEntryWithFields(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context,
                                                            String tableName,
                                                            List<com.bmc.arsys.pluginsvr.plugins.ARVendorField> fields,
                                                            long transid,
                                                            com.bmc.arsys.api.QualifierInfo qual,
                                                            List<com.bmc.arsys.api.SortInfo> sortList,
                                                            List<com.bmc.arsys.api.EntryListFieldInfo> fieldList,
                                                            int startAt,
                                                            int maxReturn,
                                                            com.bmc.arsys.api.OutputInteger numMatches)
                                                     throws com.bmc.arsys.api.ARException

Specified by:

getListEntryWithFields in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Overrides:

getListEntryWithFields in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

Throws:

com.bmc.arsys.api.ARException

getListForms

public List<com.bmc.arsys.api.VendorForm> getListForms(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context)
                                                throws com.bmc.arsys.api.ARException

Specified by:

getListForms in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Overrides:

getListForms in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

Throws:

com.bmc.arsys.api.ARException

getMultipleFields

public List<com.bmc.arsys.pluginsvr.plugins.ARVendorField> getMultipleFields(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context,
                                                                             com.bmc.arsys.api.VendorForm form)
                                                                      throws com.bmc.arsys.api.ARException

Specified by:

getMultipleFields in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Overrides:

getMultipleFields in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

Throws:

com.bmc.arsys.api.ARException

rollback

public void rollback(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context,
                     long transid)
              throws com.bmc.arsys.api.ARException

Specified by:

rollback in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Overrides:

rollback in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

Throws:

com.bmc.arsys.api.ARException

setBLOB

public void setBLOB(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context,
                    String tableName,
                    List<com.bmc.arsys.pluginsvr.plugins.ARVendorField> fields,
                    long transid,
                    String entryId,
                    int fieldId,
                    com.bmc.arsys.api.AttachmentValue blob)
             throws com.bmc.arsys.api.ARException

Specified by:

setBLOB in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Overrides:

setBLOB in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

Throws:

com.bmc.arsys.api.ARException

setEntry

public void setEntry(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context,
                     String tableName,
                     List<com.bmc.arsys.pluginsvr.plugins.ARVendorField> fields,
                     long transid,
                     String entryId,
                     com.bmc.arsys.api.Entry entry,
                     com.bmc.arsys.api.Timestamp lastModified)
              throws com.bmc.arsys.api.ARException

Specified by:

setEntry in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Overrides:

setEntry in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

Throws:

com.bmc.arsys.api.ARException

initialize

public void initialize(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context)
                throws com.bmc.arsys.api.ARException

Specified by:

initialize in interface com.bmc.arsys.pluginsvr.plugins.ARPluggable

Overrides:

initialize in class com.bmc.arsys.pluginsvr.plugins.ARPlugin

Throws:

com.bmc.arsys.api.ARException

onEvent

public void onEvent(com.bmc.arsys.pluginsvr.plugins.ARPluginContext contexxt,
                    int eventId)
             throws com.bmc.arsys.api.ARException

Specified by:

onEvent in interface com.bmc.arsys.pluginsvr.plugins.ARPluggable

Overrides:

onEvent in class com.bmc.arsys.pluginsvr.plugins.ARPlugin

Throws:

com.bmc.arsys.api.ARException

terminate

public void terminate(com.bmc.arsys.pluginsvr.plugins.ARPluginContext context)
               throws com.bmc.arsys.api.ARException

Specified by:

terminate in interface com.bmc.arsys.pluginsvr.plugins.ARPluggable

Overrides:

terminate in class com.bmc.arsys.pluginsvr.plugins.ARPlugin

Throws:

com.bmc.arsys.api.ARException