A C D F G I L O P R S T

A

AR_INTERNAL_REQ_CONFIG - Static variable in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Used as eventId in ARPlugin.onEvent(ARPluginContext, int) to indicate that ar.cfg has serverInfo changed.

ARDBCPluggable - Interface in com.bmc.arsys.pluginsvr.plugins

ARDBCPlugin - Class in com.bmc.arsys.pluginsvr.plugins

Default implemetation of the ARDBC plugin

ARDBCPlugin() - Constructor for class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

AREA_LOGIN_FAILED - Static variable in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Indicates that the user failed to authenticate

AREA_LOGIN_LOCK_OUT - Static variable in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Indicates that the user is locked out

AREA_LOGIN_SUCCESS - Static variable in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Indicates a successfull login attempt

AREA_LOGIN_UNKNOWN_USER - Static variable in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Indicates that the user is not known to the system

areaNeedSync(ARPluginContext) - Method in interface com.bmc.arsys.pluginsvr.plugins.AREAPluggable

Allows the plug-in to tell the AR Server that the user information in its cache is invalid.

areaNeedSync(ARPluginContext) - Method in class com.bmc.arsys.pluginsvr.plugins.AREAPlugin

AREAPluggable - Interface in com.bmc.arsys.pluginsvr.plugins

Sub interface of ARPluggable that defines External authentication based methods to be implemented for a AREA plugin.

AREAPlugin - Class in com.bmc.arsys.pluginsvr.plugins

Default implementation of the AREAPluggable interface

AREAPlugin() - Constructor for class com.bmc.arsys.pluginsvr.plugins.AREAPlugin

AREAResponse - Class in com.bmc.arsys.pluginsvr.plugins

A simple bean object that encapsulates the return expected for authentication from AREA plugins.

AREAResponse() - Constructor for class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Default constructor

AREAResponse(int, int, int, int, String, String, int, String, int, String, String, Timestamp) - Constructor for class com.bmc.arsys.pluginsvr.plugins.AREAResponse

areaVerifyLogin(ARPluginContext, String, String, String, String) - Method in interface com.bmc.arsys.pluginsvr.plugins.AREAPluggable

The plug-in server issues this call when the AR Server makes a request to authenticate a user.

areaVerifyLogin(ARPluginContext, String, String, String, String) - Method in class com.bmc.arsys.pluginsvr.plugins.AREAPlugin

ARFilterAPIPluggable - Interface in com.bmc.arsys.pluginsvr.plugins

Extended ARPluggable interface that defines methods specific to FilterAPI plugins.

ARFilterAPIPlugin - Class in com.bmc.arsys.pluginsvr.plugins

Default implementation of filter api plugin.

ARFilterAPIPlugin() - Constructor for class com.bmc.arsys.pluginsvr.plugins.ARFilterAPIPlugin

ARPluggable - Interface in com.bmc.arsys.pluginsvr.plugins

Parent interface for all types of AR plugins.

ARPlugin - Class in com.bmc.arsys.pluginsvr.plugins

Default implementation for the ARPluggable interface.

ARPlugin() - Constructor for class com.bmc.arsys.pluginsvr.plugins.ARPlugin

ARPluginContext - Class in com.bmc.arsys.pluginsvr.plugins

Provides the contextual information for each plugin call.

ARPluginContext(String, String, String) - Constructor for class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Constructor

ARPluginContext(String, String, String, String[], ARPluginInfo) - Constructor for class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Constructor

ARPluginContext() - Constructor for class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Default Constructor

ARPluginInfo - Class in com.bmc.arsys.pluginsvr.plugins

This class contains information about a plug-in.

ARPluginInfo(String, ARPluggable) - Constructor for class com.bmc.arsys.pluginsvr.plugins.ARPluginInfo

Create pluginInfo with name and an instance of the plug-in.

ARVendorField - Class in com.bmc.arsys.pluginsvr.plugins

This class represents a field in an ARDBCPluggable.

ARVendorField() - Constructor for class com.bmc.arsys.pluginsvr.plugins.ARVendorField

Default constructor.

ARVendorField(String, int, int) - Constructor for class com.bmc.arsys.pluginsvr.plugins.ARVendorField

Constructor that takes name, ID, and data type.

ARVendorField(String, int, int, FieldLimit) - Constructor for class com.bmc.arsys.pluginsvr.plugins.ARVendorField

Constructor that takes name, ID, data type, and field limit.

C

cancel(ARPluginContext, long) - Method in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Cancel the given transaction

cancel(ARPluginContext, long) - Method in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

com.bmc.arsys.pluginsvr.plugins - package com.bmc.arsys.pluginsvr.plugins

commit(ARPluginContext, long) - Method in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Commit the given transaction in the external datasouce

commit(ARPluginContext, long) - Method in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

createEntry(ARPluginContext, String, List<ARVendorField>, long, Entry) - Method in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Create an entry in the given table for external data source.

createEntry(ARPluginContext, String, List<ARVendorField>, long, Entry) - Method in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

D

deleteEntry(ARPluginContext, String, List<ARVendorField>, long, String) - Method in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Given the table name and entry id, delete the entry from the table in the external data source

deleteEntry(ARPluginContext, String, List<ARVendorField>, long, String) - Method in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

F

filterAPICall(ARPluginContext, List<Value>) - Method in interface com.bmc.arsys.pluginsvr.plugins.ARFilterAPIPluggable

Given a set of input values, process it and return a list of output values.

filterAPICall(ARPluginContext, List<Value>) - Method in class com.bmc.arsys.pluginsvr.plugins.ARFilterAPIPlugin

G

getARConfigEntry(String) - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

If the server configuration file was loaded from a path relative to the install path specified in the command line argument, this call will return values for tags configured in the ar.conf or ar.cfg file.

getAuthString() - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Returns the authentication string for this user session

getBLOB(ARPluginContext, String, List<ARVendorField>, long, String, int) - Method in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Given the table name, entry id and the blob field id, fetch the blob from that field in that table for that entry

getBLOB(ARPluginContext, String, List<ARVendorField>, long, String, int) - Method in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

getCmdLineArgs() - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Returns the command line arguments that the plugin server was started with.

getConfigItem(ARPluginInfo, String) - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

If ARPluginInfo == null, get the supported value of a configuration item for plugin server element in the pluginsvr_config.xml file.

getConfigItem(String) - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Get the value of a configuration item for this plug-in from the <userDefined> element in the pluginsvr_config.xml file.

getDataType() - Method in class com.bmc.arsys.pluginsvr.plugins.ARVendorField

Get the field's data type.

getEmail() - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Get the email address.

getEntry(ARPluginContext, String, List<ARVendorField>, long, String, int[]) - Method in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Given the table name, list of fields and entry id, fetch the entry from the external data source.

getEntry(ARPluginContext, String, List<ARVendorField>, long, String, int[]) - Method in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

getEntryStatistics(ARPluginContext, String, List<ARVendorField>, long, QualifierInfo, ArithmeticOrRelationalOperand, int, int[]) - Method in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Return the entry statistics for the given table and qualification.

getEntryStatistics(ARPluginContext, String, List<ARVendorField>, long, QualifierInfo, ArithmeticOrRelationalOperand, int, int[]) - Method in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

getFieldId() - Method in class com.bmc.arsys.pluginsvr.plugins.ARVendorField

Get the field ID.

getFieldLimit() - Method in class com.bmc.arsys.pluginsvr.plugins.ARVendorField

Get the field limit.

getGroups() - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Get the groups.

getLicenseApps() - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Get the application licenses.

getLicenseFTS() - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Get the FTS license.

getLicenseMask() - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Get the license mask.

getLicenseRes1() - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

getLicenseWrite() - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Get the license.

getListEntryWithFields(ARPluginContext, String, List<ARVendorField>, long, QualifierInfo, List<SortInfo>, List<EntryListFieldInfo>, int, int, OutputInteger) - Method in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Given the table name, a qualification, and list of fields to fetch the values for, return a list of entries with all fields and their values that meet the given qualification.

getListEntryWithFields(ARPluginContext, String, List<ARVendorField>, long, QualifierInfo, List<SortInfo>, List<EntryListFieldInfo>, int, int, OutputInteger) - Method in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

getListForms(ARPluginContext) - Method in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Return the list of forms/tables that needs to be exposed to the AR Server.

getListForms(ARPluginContext) - Method in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

getLoginStatus() - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Get the login status.

getLogText() - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Get the log text.

getMessageText() - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Get the message text.

getModTime() - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Get the modified time.

getMultipleFields(ARPluginContext, VendorForm) - Method in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Given the Vendor form details, return it's list of fields with all their properties

getMultipleFields(ARPluginContext, VendorForm) - Method in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

getName() - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginInfo

Get the plug-in's name.

getName() - Method in class com.bmc.arsys.pluginsvr.plugins.ARVendorField

Get the field name.

getNotifyMech() - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Get the notification mechanism.

getPluginInfo() - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Return the identification information about the plugin in the current context

getPluginInstanceLocalInfo() - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Set a map of plug-in instance stateful information that plug-in would want to keep.

getRemoteHostCharSet() - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

The remote host character set for current request.

getUser() - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Returns the user name for the api call that resulted in this plugin call.

getUserSessionGuid() - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Returns the session specific guid for this user session, that can be used for authentication purposes along with the user name to make AR API calls to the AR Server in the midst of a plugin call.

getVersion() - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginInfo

Get the plug-in's version

I

initialize(ARPluginContext) - Method in interface com.bmc.arsys.pluginsvr.plugins.ARPluggable

An initialization routine called once at startup load time for each plugin that is loaded.

initialize(ARPluginContext) - Method in class com.bmc.arsys.pluginsvr.plugins.ARPlugin

isPluginsvrStarted() - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Check if current instance of java plug-in server is started and ready to take rpc calls

L

logMessage(ARPluginInfo, int, String) - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Given the identification of the plugin, the level and message to log, log all relevant info into the plugin log file, depending on the log level configuration of the plugin server.

logMessage(int, String) - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Given the level and message to log, log all relevant info including current plugin info, into the plugin log file, depending on the log level configuration of the plugin server.

O

onEvent(ARPluginContext, int) - Method in interface com.bmc.arsys.pluginsvr.plugins.ARPluggable

Methods to handle events from the AR Server.

onEvent(ARPluginContext, int) - Method in class com.bmc.arsys.pluginsvr.plugins.ARPlugin

P

PLUGIN_LOG_LEVEL_ERROR - Static variable in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Logging level for warning messages.

PLUGIN_LOG_LEVEL_FATAL - Static variable in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Logging level for fatal messages

PLUGIN_LOG_LEVEL_INFO - Static variable in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Logging level for informational messages.

PLUGIN_LOG_LEVEL_WARNING - Static variable in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Logging level for warning messages.

R

rollback(ARPluginContext, long) - Method in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Rollback the given transaction in the external datasource.

rollback(ARPluginContext, long) - Method in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

S

setBLOB(ARPluginContext, String, List<ARVendorField>, long, String, int, AttachmentValue) - Method in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Given the table, entry and the blob field id, insert the blob into the external datasource table

setBLOB(ARPluginContext, String, List<ARVendorField>, long, String, int, AttachmentValue) - Method in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

setConfigItem(ARPluginInfo, String, String) - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Set the value of a configuration item for the identified plug-in from the <userDefined> element in the pluginsvr_config.xml file.

setConfigItem(String, String) - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Set the value of a configuration item for this plug-in from the <userDefined> element in the pluginsvr_config.xml file.

setDataType(int) - Method in class com.bmc.arsys.pluginsvr.plugins.ARVendorField

Set the field's data type.

setEmail(String) - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Set the email address.

setEntry(ARPluginContext, String, List<ARVendorField>, long, String, Entry, Timestamp) - Method in interface com.bmc.arsys.pluginsvr.plugins.ARDBCPluggable

Given the table name, and entry object, modify the entry recognized by the entry key of the entry object in the external datasource.

setEntry(ARPluginContext, String, List<ARVendorField>, long, String, Entry, Timestamp) - Method in class com.bmc.arsys.pluginsvr.plugins.ARDBCPlugin

setFieldId(int) - Method in class com.bmc.arsys.pluginsvr.plugins.ARVendorField

Set the field ID.

setFieldLimit(FieldLimit) - Method in class com.bmc.arsys.pluginsvr.plugins.ARVendorField

Set the field limit.

setGroups(String) - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Set the groups.

setLicenseApps(String) - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Set the application licenses.

setLicenseFTS(int) - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Set the FTS license.

setLicenseMask(int) - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Set the license mask.

setLicenseRes1(int) - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

setLicenseWrite(int) - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Set the license.

setLoginStatus(int) - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Set the login status.

setLogText(String) - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Set the log text.

setMessageText(String) - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Set the message text.

setModTime(Timestamp) - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Set the modified time.

setName(String) - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginInfo

Set the plug-in's name.

setName(String) - Method in class com.bmc.arsys.pluginsvr.plugins.ARVendorField

Set the field name.

setNotifyMech(int) - Method in class com.bmc.arsys.pluginsvr.plugins.AREAResponse

Set the notification mechanism.

setPluginInstanceLocalInfo(Map<Object, Object>) - Method in class com.bmc.arsys.pluginsvr.plugins.ARPluginContext

Set the plug-in instance local info back to plug-in server, so that next call to this same plug-in instance will contain them, no matter what thread calling this instance.

T

terminate(ARPluginContext) - Method in interface com.bmc.arsys.pluginsvr.plugins.ARPluggable

A clean up method called on a plugin unload or plugin server termination for the plugin to cleanup after itself.

terminate(ARPluginContext) - Method in class com.bmc.arsys.pluginsvr.plugins.ARPlugin

A C D F G I L O P R S T