| Package | Description |
|---|---|
| org.jinterop.dcom.core |
Defines the classes and data structures required to work with j-Interop.
|
| org.jinterop.dcom.impls |
Defines factories to all external interfaces such as automation (IDispatch, ITypeInfo , IEnumVariant etc) and any other out of the box wrappers provided by j-Interop.
|
| org.jinterop.dcom.impls.automation |
Defines out-of-box classes for usage with COM servers supporting automation.
|
| org.jinterop.dcom.test | |
| org.jinterop.winreg |
Defines classes to access Windows Registry.
|
| org.jinterop.winreg.smb | |
| org.openscada.opc.dcom.common | |
| org.openscada.opc.dcom.common.impl | |
| org.openscada.opc.dcom.da | |
| org.openscada.opc.dcom.da.impl | |
| org.openscada.opc.dcom.list.impl | |
| org.openscada.opc.lib.da | |
| org.openscada.opc.lib.da.browser | |
| org.openscada.opc.lib.list |
| Modifier and Type | Method and Description |
|---|---|
void |
JIStruct.addMember(int position,
Object member)
Adds object as member to the index specified.
|
void |
JIStruct.addMember(Object member)
Adds the object as a member of this structure.
|
void |
JIUnion.addMember(Object discriminant,
JIStruct member)
Adds a member to this Union.
|
void |
JIUnion.addMember(Object discriminant,
Object member)
Adds a member to this Union.
|
void |
JIComObjectImplWrapper.addRef() |
void |
IJIComObject.addRef()
Increases the reference count on the COM server by 5
(currently hard coded).
|
static String |
JIFrameworkHelper.attachEventHandler(IJIComObject comObject,
String sourceUUID,
IJIComObject eventListener) |
Object[] |
JIComObjectImplWrapper.call(JICallBuilder obj) |
Object[] |
IJIComObject.call(JICallBuilder obj)
Executes a method call on the actual COM object represented by this interface.
|
Object[] |
JIComObjectImplWrapper.call(JICallBuilder obj,
int timeout) |
Object[] |
IJIComObject.call(JICallBuilder obj,
int timeout)
Refer
IJIComObject.call(JICallBuilder) for details on this method. |
IJIComObject |
JIComServer.createInstance()
Returns an
IJIComObject representing the COM Server. |
static void |
JISession.destroySession(JISession session)
Used to destroy the
session, this release all references of the COM server and it's interfaces. |
static void |
JIFrameworkHelper.detachEventHandler(IJIComObject comObject,
String identifier) |
JIClsid |
JIProgId.getCorrespondingCLSID()
Returns the
CLSID for this ProgId. |
Object |
JIVariant.getObject()
Returns the contained object.
|
JIArray |
JIVariant.getObjectAsArray()
Retrieves the contained object as
JIArray. |
boolean |
JIVariant.getObjectAsBoolean()
Retrieves the contained object as
boolean. |
char |
JIVariant.getObjectAsChar()
Retrieves the contained object as
char. |
IJIComObject |
JIVariant.getObjectAsComObject()
Retrieves the contained object as
IJIComObject. |
Date |
JIVariant.getObjectAsDate()
Retrieves the contained object as
java.util.Date. |
double |
JIVariant.getObjectAsDouble()
Retrieves the contained object as
double. |
float |
JIVariant.getObjectAsFloat()
Retrieves the contained object as
float. |
int |
JIVariant.getObjectAsInt()
Retrieves the contained object as
int. |
long |
JIVariant.getObjectAsLong()
Retrieves the contained object as
long, used when the expected type is VT_I8. |
int |
JIVariant.getObjectAsSCODE()
Retrieves the contained objects errorCode.
|
short |
JIVariant.getObjectAsShort()
Retrieves the contained object as
short. |
JIString |
JIVariant.getObjectAsString()
Retrieves the contained object as
JIString. |
String |
JIVariant.getObjectAsString2()
Retrieves the contained object as
String. |
IJIUnsigned |
JIVariant.getObjectAsUnsigned()
Retrieves the contained object as
unsigned number. |
JIVariant |
JIVariant.getObjectAsVariant()
Retrieves the contained object as
JIVariant. |
int |
JIVariant.getType()
Returns the referent as integer.
|
static IJIComObject |
JIFrameworkHelper.instantiateComObject(JISession session,
byte[] rawBytes,
String ipAddress)
Returns an Interface Pointer representation from raw bytes.
|
static IJIComObject |
JIFrameworkHelper.instantiateComObject(JISession session,
IJIComObject comObject)
Typically used in the Man-In-The-Middle scenario, where one j-Interop system interacts with another over the wire.
|
static IJIComObject |
JIFrameworkHelper.instantiateLocalComObject(JISession session,
JILocalCoClass javaComponent)
Returns an Interface Pointer representation for the Java Component
|
boolean |
JIVariant.isArray() |
boolean |
JIVariant.isByRefFlagSet() |
IJIComObject |
JIComObjectImplWrapper.queryInterface(String iid) |
IJIComObject |
IJIComObject.queryInterface(String iid)
Retrieve interface references based on
iid. |
void |
JIComObjectImplWrapper.release() |
void |
IJIComObject.release()
Decreases the reference count on the COM server by 5
(currently hard coded).
|
| Constructor and Description |
|---|
JIComServer(JIClsid clsid,
JISession session)
based constructor with the host machine for COM server being LOCALHOST. |
JIComServer(JIClsid clsid,
String address,
JISession session)
Refer
JIComServer.JIComServer(JIClsid, JISession) for details. |
JIComServer(JIProgId progId,
JISession session)
JIProgId based constructor with the host machine for COM server being LOCALHOST. |
JIComServer(JIProgId progId,
String address,
JISession session)
Refer
JIComServer.JIComServer(JIProgId, JISession) for details. |
| Modifier and Type | Method and Description |
|---|---|
static String |
JIObjectFactory.attachEventHandler(IJIComObject comObject,
String sourceUUID,
IJIComObject eventListener)
Attaches an event handler to
comObject for the source event interface of COM , identified by the
sourceUUID. |
static IJIComObject |
JIObjectFactory.buildObject(JISession session,
byte[] rawBytes)
Returns a COM Object from raw bytes.
|
static IJIComObject |
JIObjectFactory.buildObject(JISession session,
byte[] rawBytes,
String ipAddress)
Returns a COM Object from raw bytes.
|
static IJIComObject |
JIObjectFactory.buildObject(JISession session,
JILocalCoClass javaComponent)
Returns a local COM Object representation for the Java component.
|
static void |
JIObjectFactory.detachEventHandler(IJIComObject comObject,
String identifier)
Detaches the event handler identified by
identifier and associated with this comObject. |
static IJIComObject |
JIObjectFactory.narrowObject(IJIComObject comObject)
Narrows the
comObject into its right type based on it's IID. |
static IJIComObject |
JIObjectFactory.narrowObject(JISession session,
IJIComObject comObject)
Typically used in the Man-In-The-Middle scenario.
|
| Modifier and Type | Class and Description |
|---|---|
class |
JIAutomationException
Class for signifying Automation related exceptions.
|
| Modifier and Type | Method and Description |
|---|---|
void |
IJIDispatch.callMethod(int dispId)
Performs a
method call for the method identified by the dispId parameter. |
void |
IJIDispatch.callMethod(int dispId,
Object[] inparams)
Performs a
method call for the method identified by the dispId parameter. |
void |
IJIDispatch.callMethod(int dispId,
Object[] inparams,
int[] dispIds)
Performs a
method call for the method identified by the dispId parameter. |
void |
IJIDispatch.callMethod(String name)
Performs a
method call for the method identified by the name parameter. |
void |
IJIDispatch.callMethod(String name,
Object[] inparams)
Performs a
method call for the method identified by the name parameter. |
void |
IJIDispatch.callMethod(String name,
Object[] inparams,
int[] dispIds)
Performs a
method call for the method identified by the name parameter. |
void |
IJIDispatch.callMethod(String name,
Object[] inparams,
String[] paramNames)
Performs a
method call for the method identified by the name parameter. |
JIVariant |
IJIDispatch.callMethodA(int dispId)
Performs a
method call for the method identified by the dispId parameter. |
JIVariant[] |
IJIDispatch.callMethodA(int dispId,
Object[] inparams)
Performs a
method call for the method identified by the dispId parameter. |
JIVariant[] |
IJIDispatch.callMethodA(int dispId,
Object[] inparams,
int[] dispIds)
Performs a
method call for the method identified by the dispId parameter. |
JIVariant |
IJIDispatch.callMethodA(String name)
Performs a
method call for the method identified by the name parameter. |
JIVariant[] |
IJIDispatch.callMethodA(String name,
Object[] inparams)
Performs a
method call for the method identified by the name parameter. |
JIVariant[] |
IJIDispatch.callMethodA(String name,
Object[] inparams,
int[] dispIds)
Performs a
method call for the method identified by the name parameter. |
JIVariant[] |
IJIDispatch.callMethodA(String name,
Object[] inparams,
String[] paramNames)
Performs a
method call for the method identified by the name parameter. |
IJIEnumVariant |
IJIEnumVariant.Clone()
Definition from MSDN:
Creates a copy of the current state of enumeration.
|
IJIComObject |
IJITypeInfo.createInstance(String riid)
Creates a new instance of a type that describes a component object class (coclass).
|
Object[] |
IJITypeLib.findName(JIString nameBuf,
int hashValue,
short found)
Finds occurrences of a type description in a type library.
|
JIVariant |
IJIDispatch.get(int dispId)
Performs a
propget for the method identified by the dispId. |
JIVariant[] |
IJIDispatch.get(int dispId,
Object[] inparams)
Performs a
propget for the method identified by the dispId parameter. |
JIVariant |
IJIDispatch.get(String name)
Performs a
propget for the method identified by the name parameter. |
JIVariant[] |
IJIDispatch.get(String name,
Object[] inparams)
Performs a
propget for the method identified by the name parameter. |
Object[] |
IJITypeInfo.getContainingTypeLib()
Retrieves the containing type library and the index of the type description within that type library.
|
Object[] |
IJITypeInfo.getDllEntry(int memberId,
int invKind)
Retrieves a description or specification of an entry point for a function in a DLL.
|
Object[] |
IJITypeLib.getDocumentation(int memberId)
Retrieves the library's documentation string, the complete Help file name and path, and the context
identifier for the library Help topic in the Help file.
|
Object[] |
IJITypeInfo.getDocumentation(int memberId)
Retrieves the documentation string, the complete Help file name and path, and the context ID for the Help
topic for a specified type description.
|
FuncDesc |
IJITypeInfo.getFuncDesc(int index)
Retrieves the FuncDesc structure that contains information about a specified function.
|
int |
IJIDispatch.getIDsOfNames(String apiName)
Maps a method name to its corresponding
DISPID.The result of this call is cached
for further usage and no network call is performed again for the same method name. |
int[] |
IJIDispatch.getIDsOfNames(String[] apiName)
Maps a single method name and an optional set of it's argument names to a corresponding set of
DISPIDs. |
int |
IJITypeInfo.getImplTypeFlags(int index)
Retrieves the IMPLTYPEFLAGS enumeration for one implemented interface or base interface in a type description.
|
void |
IJITypeLib.getLibAttr()
Retrieves the structure that contains the library's attributes.
|
JIString |
IJITypeInfo.getMops(int memberId)
Retrieves marshaling information.
|
Object[] |
IJITypeInfo.getNames(int memberId,
int maxNames)
Retrieves the variable with the specified member ID (or the name of the property or method and its parameters)
that correspond to the specified function ID.
|
IJITypeInfo |
IJITypeInfo.getRefTypeInfo(int hrefType)
If a type description references other type descriptions, it retrieves the referenced type descriptions.
|
int |
IJITypeInfo.getRefTypeOfImplType(int index)
If a type description describes a COM class, it retrieves the type description of the implemented
interface types.
|
TypeAttr |
IJITypeInfo.getTypeAttr()
Retrieves a TypeAttr structure that contains the attributes of the type description.
|
IJITypeInfo |
IJITypeLib.getTypeInfo(int index)
Retrieves the specified type description in the library.
|
IJITypeInfo |
IJIDispatch.getTypeInfo(int typeInfo)
Returns an implementation of COM
ITypeInfo interface based on the typeInfo. |
int |
IJITypeLib.getTypeInfoCount()
Returns the number of type descriptions in the type library.
|
int |
IJIDispatch.getTypeInfoCount()
Definition from MSDN:
Determines whether there is type information available for the dual interface.
|
IJITypeInfo |
IJITypeLib.getTypeInfoOfGuid(String uuid)
Retrieves the type description that corresponds to the specified GUID.
|
int |
IJITypeLib.getTypeInfoType(int index)
Retrieves the type of a type description.
|
VarDesc |
IJITypeInfo.getVarDesc(int index)
Retrieves a VARDESC structure that describes the specified variable.
|
static IJIComObject |
Internal_JIAutomationFactory.narrowObject(IJIComObject comObject) |
Object[] |
IJIEnumVariant.next(int celt)
Definition from MSDN:
Attempts to get the next celt items in the enumeration sequence.
|
void |
IJIDispatch.put(int dispId,
JIVariant inparam)
Performs a
propput for the method identified by the dispId. |
void |
IJIDispatch.put(int dispId,
Object[] params)
Performs a
propput for the method identified by the dispId |
void |
IJIDispatch.put(String name,
JIVariant inparam)
Performs a
propput for the method identified by the name parameter. |
void |
IJIDispatch.put(String name,
Object[] params)
Performs a
propput for the method identified by the name parameter. |
void |
IJIDispatch.putRef(int dispId,
JIVariant inparam)
Performs a
propputref for the method identified by the dispId. |
void |
IJIDispatch.putRef(int dispId,
Object[] params)
Performs a
propputref for the method identified by the dispId. |
void |
IJIDispatch.putRef(String name,
JIVariant inparam)
Performs a
propput for the method identified by the name parameter. |
void |
IJIDispatch.putRef(String name,
Object[] params)
Performs a
propput for the method identified by the name parameter. |
void |
IJIEnumVariant.reset()
Definition from MSDN:
Resets the enumeration sequence to the beginning.
|
void |
IJIEnumVariant.skip(int celt)
Definition from MSDN: Attempts to skip over the next celt elements in the enumeration sequence.
|
| Constructor and Description |
|---|
JIAutomationException(JIException e) |
| Modifier and Type | Method and Description |
|---|---|
JIVariant |
DWebBrowserEvents2.BeforeNavigate2(IJIComObject dispatch,
JIVariant URL,
JIVariant Flags,
JIVariant TargetFrameName,
JIVariant PostData,
JIVariant Headers,
JIVariant Cancel) |
void |
MSPowerPoint2.closePresentation(IJIDispatch presentation) |
void |
MSExcel3.createWorkSheet() |
void |
MSExcel2_Test.createWorkSheet() |
void |
MSExcel2.createWorkSheet() |
void |
MSExcel.createWorkSheet() |
void |
MSExcel.createXYChart() |
void |
MSPowerPoint2.do_Next_Action(IJIDispatch view) |
void |
MSPowerPoint2.do_Previous_Action(IJIDispatch view) |
void |
DWebBrowserEvents2.DocumentComplete(IJIComObject pDisp,
JIVariant URL) |
void |
QtpComTest.envQtp() |
void |
TestCOMServer.execute() |
JIVariant |
DWebBrowserEvents2.FileDownload(boolean noIdeaWhat,
JIVariant Cancel) |
void |
SampleTestServer.getConformantIntArray() |
void |
SampleTestServer.getConformantStruct(String[] args) |
void |
MetrikonOPC.getOPC() |
void |
SampleTestServer.GetSimpleArrayStruct(String[] args) |
void |
SampleTestServer.GetSimpleArrayStructArray(String[] args) |
void |
SampleTestServer.getSimpleStruct(String[] args) |
void |
SampleTestServer.getSimpleStructArray(String[] args) |
void |
SampleTestServer.GetStaticStruct(String[] args) |
void |
SampleTestServer.GetStruct(String[] args) |
void |
SampleTestServer.GetStructStruct(String[] args) |
void |
SampleTestServer.GetStructStructArray(String[] args) |
void |
SampleTestServer.getTCharArray() |
void |
MSPowerPoint2.goto_First_Slide(IJIDispatch view) |
void |
MSPowerPoint2.goto_Last_Slide(IJIDispatch view) |
void |
MSPowerPoint2.goto_Numbered_Slide(IJIDispatch view,
int index) |
void |
DWebBrowserEvents2.NavigateComplete2(IJIComObject pDisp,
JIVariant URL) |
JIVariant |
DWebBrowserEvents2.NavigateError(IJIComObject pDisp,
JIVariant URL,
JIVariant Frame,
JIVariant StatusCode,
JIVariant Cancel) |
JIVariant |
DWebBrowserEvents2.NewWindow2(JIVariant ppDisp,
JIVariant Cancel) |
JIVariant |
DWebBrowserEvents2.NewWindow3(JIVariant ppDisp,
JIVariant Cancel,
int dwFlags,
JIString bstrUrlContext,
JIString bstrUrl) |
Object[] |
JIOPCEventSink.onEvent(int clientSubscription,
int refresh,
int lastRefresh,
int count,
JIArray eventsArray)
This method is provided by the client to handle notifications from the OPCEventSubscription for events.
|
IJIDispatch |
MSPowerPoint2.openPresentation(String fullEscapedPath) |
void |
MSExcel2.pasteArrayToWorkSheet() |
void |
MSExcel2_Test.pasteArrayToWorkSheet(int nRow) |
void |
MSExcel.pasteStringToWorkSheet() |
void |
SampleTestServer.performCallback(String[] args) |
void |
MetrikonOPC.performOp() |
void |
MSWord2.performOp() |
void |
MSWord.performOp() |
void |
MSWMI2.performOp() |
void |
MSWMI.performOp() |
void |
MSPowerPoint.performOp() |
void |
MSEnumVariant.performOp() |
void |
MSADO.performOp() |
void |
KainTest.performOp() |
void |
SampleTestServer.performSquare(String[] args) |
void |
MSPowerPoint2.quitPowerPoint() |
IJIDispatch |
MSPowerPoint2.runPresentation(IJIDispatch activePresentation) |
void |
MSPowerPoint2.savePresentationAs(IJIDispatch presentation,
String fullEscapedPath) |
void |
SampleTestServer.setConformantIntArray() |
void |
DWebBrowserEvents2.SetPhishingFilterStatus(int PhishingFilterStatus) |
void |
SampleTestServer.SetSimpleArrayStructArray(String[] args) |
void |
SampleTestServer.SetStaticStruct(String[] args) |
void |
SampleTestServer.setTCharArray() |
void |
MSExcel3.showExcel() |
void |
MSExcel2_Test.showExcel() |
void |
MSExcel2.showExcel() |
void |
MSExcel.showExcel() |
void |
MSPowerPoint2.showPowerPoint() |
void |
MSPowerPoint.showPowerPoint() |
void |
QtpComTest.showQtp() |
void |
MSWord2.showWord() |
void |
MSWord.showWord() |
void |
KainTest.showWord() |
void |
MSTypeLibraryBrowser2.start() |
void |
MSTypeLibraryBrowser.start() |
void |
MSExcel3.startExcel() |
void |
MSExcel2_Test.startExcel() |
void |
MSExcel2.startExcel() |
void |
MSExcel.startExcel() |
void |
MSPowerPoint2.startPowerPoint() |
void |
MSPowerPoint.startPowerPoint() |
void |
QtpComTest.startQTP() |
void |
MSWord2.startWord() |
void |
MSWord.startWord() |
void |
KainTest.startWord() |
void |
WshShell.startWScript() |
static void |
SampleTestServerCallback.testSinkDebug(String[] args) |
static void |
SampleTestServerCallback.testStaticUpdateMeSink(String[] args) |
JIVariant |
DWebBrowserEvents2.WindowClosing(boolean IsChildWindow,
JIVariant Cancel) |
| Modifier and Type | Method and Description |
|---|---|
void |
IJIWinReg.closeConnection()
Closes this connection, but a word of caution, it does not close any OPEN Key.
|
void |
IJIWinReg.winreg_CloseKey(JIPolicyHandle handle)
Closes the key.
|
JIPolicyHandle |
IJIWinReg.winreg_CreateKey(JIPolicyHandle handle,
String subKey,
int options,
int accessMask)
Creates a new key by name subKey under the handle.
|
void |
IJIWinReg.winreg_DeleteKeyOrValue(JIPolicyHandle handle,
String valueName,
boolean isKey)
Deletes a key or value specified by valueName.
|
String[] |
IJIWinReg.winreg_EnumKey(JIPolicyHandle handle,
int index)
Returns name and class (in that order) for the key identified by index under parent handle.
|
Object[] |
IJIWinReg.winreg_EnumValue(JIPolicyHandle handle,
int index)
Returns name and type (in that order) for the value identified by index under parent handle.
|
JIPolicyHandle |
IJIWinReg.winreg_OpenHKCR()
Opens the HKEY_CLASSES_ROOT key
|
JIPolicyHandle |
IJIWinReg.winreg_OpenHKCU()
Opens the HKEY_CURRENT_USER key
|
JIPolicyHandle |
IJIWinReg.winreg_OpenHKLM()
Opens the HKEY_LOCAL_MACHINE key
|
JIPolicyHandle |
IJIWinReg.winreg_OpenHKU()
Opens the HKEY_USERS key
|
JIPolicyHandle |
IJIWinReg.winreg_OpenKey(JIPolicyHandle handle,
String key,
int accessMask)
Opens the subkey of key specified by handle.
|
byte[] |
IJIWinReg.winreg_QueryValue(JIPolicyHandle handle,
int bufferSize)
Query the key for it's name.
|
Object[] |
IJIWinReg.winreg_QueryValue(JIPolicyHandle handle,
String valueName,
int bufferSize)
Query the key-value for it's value.Please put buffer size more than the estimated expected value.
|
void |
IJIWinReg.winreg_SaveFile(JIPolicyHandle handle,
String fileName)
Saves registry entries from handle location to local fileName.
|
void |
IJIWinReg.winreg_SetValue(JIPolicyHandle handle,
String valueName)
Sets an empty name-value for a REG_NONE type.
|
void |
IJIWinReg.winreg_SetValue(JIPolicyHandle handle,
String valueName,
byte[][] data)
Sets name-value for a REG_MULTI_SZ type.
|
void |
IJIWinReg.winreg_SetValue(JIPolicyHandle handle,
String valueName,
byte[] data,
boolean binary,
boolean expand_sz)
Sets name-value for a REG_SZ\REG_EXPAND_SZ\REG_BINARY type.
|
void |
IJIWinReg.winreg_SetValue(JIPolicyHandle handle,
String valueName,
int data)
Sets name-value for a REG_DWORD type.
|
| Modifier and Type | Method and Description |
|---|---|
void |
JIWinRegStub.closeConnection() |
void |
JIWinRegStub.winreg_CloseKey(JIPolicyHandle handle) |
JIPolicyHandle |
JIWinRegStub.winreg_CreateKey(JIPolicyHandle handle,
String subKey,
int options,
int accessMask) |
void |
JIWinRegStub.winreg_DeleteKeyOrValue(JIPolicyHandle handle,
String valueName,
boolean isKey) |
String[] |
JIWinRegStub.winreg_EnumKey(JIPolicyHandle handle,
int index) |
Object[] |
JIWinRegStub.winreg_EnumValue(JIPolicyHandle handle,
int index) |
JIPolicyHandle |
JIWinRegStub.winreg_OpenHKCR() |
JIPolicyHandle |
JIWinRegStub.winreg_OpenHKCU() |
JIPolicyHandle |
JIWinRegStub.winreg_OpenHKLM() |
JIPolicyHandle |
JIWinRegStub.winreg_OpenHKU() |
JIPolicyHandle |
JIWinRegStub.winreg_OpenKey(JIPolicyHandle handle,
String key,
int accessMask) |
byte[] |
JIWinRegStub.winreg_QueryValue(JIPolicyHandle handle,
int bufferSize) |
Object[] |
JIWinRegStub.winreg_QueryValue(JIPolicyHandle handle,
String valueName,
int bufferSize) |
void |
JIWinRegStub.winreg_SaveFile(JIPolicyHandle handle,
String fileName) |
void |
JIWinRegStub.winreg_SetValue(JIPolicyHandle handle,
String valueName) |
void |
JIWinRegStub.winreg_SetValue(JIPolicyHandle handle,
String valueName,
byte[][] data) |
void |
JIWinRegStub.winreg_SetValue(JIPolicyHandle handle,
String valueName,
byte[] data,
boolean isBinary,
boolean expand_sz) |
void |
JIWinRegStub.winreg_SetValue(JIPolicyHandle handle,
String valueName,
int data) |
| Modifier and Type | Method and Description |
|---|---|
void |
EventHandler.detach() |
static JIStruct |
FILETIME.getStruct() |
| Modifier and Type | Method and Description |
|---|---|
Collection<String> |
EnumString.asCollection() |
Collection<UUID> |
EnumGUID.asCollection() |
Collection<String> |
EnumString.asCollection(int batchSize) |
Collection<UUID> |
EnumGUID.asCollection(int batchSize) |
static Object[] |
Helper.callRespectSFALSE(IJIComObject object,
JICallBuilder callObject)
Make the COM call but do not treat S_FALSE as error condition for the whole call
|
EnumString |
EnumString.cloneObject() |
EnumGUID |
EnumGUID.cloneObject() |
void |
EventHandlerImpl.detach() |
static JIVariant |
Helper.fixVariant(JIVariant value)
Perform some fixes on the variant when writing it to OPC items.
|
String |
OPCCommon.getErrorString(int errorCode,
int localeID) |
int |
OPCCommon.getLocaleID() |
Collection<String> |
EnumString.next(int num) |
Collection<UUID> |
EnumGUID.next(int num) |
int |
EnumString.next(List<String> list,
int num) |
int |
EnumGUID.next(List<UUID> list,
int num) |
Collection<Integer> |
OPCCommon.queryAvailableLocaleIDs() |
void |
EnumString.reset() |
void |
EnumGUID.reset() |
void |
OPCCommon.setClientName(String clientName) |
void |
OPCCommon.setLocaleID(int localeID) |
void |
EnumString.skip(int num) |
void |
EnumGUID.skip(int num) |
| Constructor and Description |
|---|
EnumGUID(IJIComObject enumStringObject) |
EnumString(IJIComObject enumStringObject) |
OPCCommon(IJIComObject opcObject) |
| Modifier and Type | Method and Description |
|---|---|
static JIStruct |
OPCSERVERSTATUS.getStruct() |
static JIStruct |
OPCITEMSTATE.getStruct() |
static JIStruct |
OPCITEMRESULT.getStruct() |
JIStruct |
OPCITEMDEF.toStruct()
Convert to structure to a J-Interop structure
|
| Modifier and Type | Method and Description |
|---|---|
KeyedResultSet<OPCITEMDEF,OPCITEMRESULT> |
OPCItemMgt.add(OPCITEMDEF... items) |
OPCGroupStateMgt |
OPCServer.addGroup(String name,
boolean active,
int updateRate,
int clientHandle,
Integer timeBias,
Float percentDeadband,
int localeID) |
EventHandler |
OPCGroupStateMgt.attach(IOPCDataCallback callback)
Attach a new callback to the group
|
EnumString |
OPCBrowseServerAddressSpace.browse(OPCBROWSETYPE browseType,
String filterCriteria,
int accessRights,
int dataType) |
EnumString |
OPCBrowseServerAddressSpace.browseAccessPaths(String itemID)
Return the possible access paths for an item
|
void |
OPCAsyncIO2.cancel(int cancelId) |
void |
OPCBrowseServerAddressSpace.changePosition(String position,
OPCBROWSEDIRECTION direction)
Direct the browser to another position
Depending on the direction the new position will be set based on the provided
position information.
|
OPCGroupStateMgt |
OPCGroupStateMgt.clone(String name)
Clone the group
|
JILocalCoClass |
OPCDataCallback.getCoClass() |
OPCGroupStateMgt |
OPCServer.getGroupByName(String name) |
EnumString |
OPCServer.getGroups(OPCENUMSCOPE scope)
Get the groups
|
String |
OPCBrowseServerAddressSpace.getItemID(String item)
Get the complete item id from an item at the local position.
|
OPCItemMgt |
OPCGroupStateMgt.getItemManagement() |
KeyedResultSet<Integer,JIVariant> |
OPCItemProperties.getItemProperties(String itemID,
int... properties) |
OPCGroupState |
OPCGroupStateMgt.getState() |
OPCSERVERSTATUS |
OPCServer.getStatus()
Retrieve the current server status
|
KeyedResultSet<Integer,String> |
OPCItemProperties.lookupItemIDs(String itemID,
int... properties) |
Collection<PropertyDescription> |
OPCItemProperties.queryAvailableProperties(String itemID) |
OPCNAMESPACETYPE |
OPCBrowseServerAddressSpace.queryOrganization()
Get the information how the namespace is organized
|
OPCAsyncIO2.AsyncResult |
OPCAsyncIO2.read(int transactionId,
Integer... serverHandles) |
void |
OPCItemIO.read(IORequest[] requests) |
KeyedResultSet<Integer,OPCITEMSTATE> |
OPCSyncIO.read(OPCDATASOURCE source,
Integer... serverHandles) |
int |
OPCAsyncIO2.refresh(OPCDATASOURCE dataSource,
int transactionID) |
ResultSet<Integer> |
OPCItemMgt.remove(Integer... serverHandles) |
void |
OPCServer.removeGroup(int serverHandle,
boolean force) |
void |
OPCServer.removeGroup(OPCGroupStateMgt group,
boolean force) |
ResultSet<Integer> |
OPCItemMgt.setActiveState(boolean state,
Integer... items) |
ResultSet<Integer> |
OPCItemMgt.setClientHandles(Integer[] serverHandles,
Integer[] clientHandles) |
void |
OPCAsyncIO2.setEnable(boolean state) |
void |
OPCGroupStateMgt.setName(String name)
Rename to group
|
int |
OPCGroupStateMgt.setState(Integer requestedUpdateRate,
Boolean active,
Integer timeBias,
Float percentDeadband,
Integer localeID,
Integer clientHandle)
Set the group state Leaving any of the parameters
null will keep the current value untouched. |
KeyedResultSet<OPCITEMDEF,OPCITEMRESULT> |
OPCItemMgt.validate(OPCITEMDEF... items) |
ResultSet<WriteRequest> |
OPCSyncIO.write(WriteRequest... requests) |
| Constructor and Description |
|---|
OPCAsyncIO2(IJIComObject opcAsyncIO2) |
OPCBrowse(IJIComObject opcServer) |
OPCBrowseServerAddressSpace(IJIComObject opcServer) |
OPCGroupStateMgt(IJIComObject opcGroup) |
OPCItemIO(IJIComObject opcItemIO) |
OPCItemMgt(IJIComObject opcGroup) |
OPCItemProperties(IJIComObject opcItemProperties) |
OPCServer(IJIComObject opcServer) |
OPCSyncIO(IJIComObject opcSyncIO) |
| Modifier and Type | Method and Description |
|---|---|
EnumGUID |
OPCServerList.enumClassesOfCategories(String[] implemented,
String[] required) |
EnumGUID |
OPCServerList.enumClassesOfCategories(UUID[] implemented,
UUID[] required) |
ClassDetails |
OPCServerList.getClassDetails(JIClsid clsId)
Return details about a serve class
|
JIClsid |
OPCServerList.getCLSIDFromProgID(String progId) |
| Constructor and Description |
|---|
OPCServerList(IJIComObject listObject) |
| Modifier and Type | Method and Description |
|---|---|
Group |
Server.addGroup()
Add a new group and let the server generate a group name
Actually this method only calls
Server.addGroup(String) with null
as parameter. |
Group |
Server.addGroup(String name)
Add a new named group to the server
|
Item |
Group.addItem(String item)
Add a single item.
|
void |
AccessBase.addItem(String itemId,
DataCallback dataCallback) |
Map<String,Item> |
Group.addItems(String... items)
Add new items to the group
|
EventHandler |
Group.attach(IOPCDataCallback dataCallback) |
void |
Group.clear() |
void |
Server.connect() |
Group |
Server.findGroup(String name)
Find a group by its name
|
protected Group |
Server.getGroup(OPCGroupStateMgt groupMgt) |
String |
Group.getName()
Get the group name from the server
|
TreeBrowser |
Server.getTreeBrowser()
Get the tree browser
|
boolean |
Group.isActive() |
ItemState |
Item.read(boolean device) |
Map<Item,ItemState> |
Group.read(boolean device,
Item... items) |
protected void |
AccessBase.realizeItem(String itemId) |
void |
Group.remove()
remove the group from the server
|
void |
Server.removeGroup(Group group,
boolean force) |
void |
Group.removeItem(String opcItemId) |
protected void |
SyncAccess.runOnce() |
void |
Item.setActive(boolean state) |
void |
Group.setActive(boolean state) |
void |
Group.setActive(boolean state,
Item... items) |
void |
Group.setName(String name)
Change the group name
|
protected void |
SyncAccess.start() |
protected void |
Async20Access.start() |
protected void |
AccessBase.start() |
protected void |
SyncAccess.stop() |
protected void |
Async20Access.stop() |
protected void |
AccessBase.stop() |
void |
AccessBase.unbind() |
Map<String,Result<OPCITEMRESULT>> |
Group.validateItems(String... items)
Validate item ids and get additional information to them.
|
Integer |
Item.write(JIVariant value) |
Map<Item,Integer> |
Group.write(WriteRequest... requests) |
| Constructor and Description |
|---|
AccessBase(Server server,
int period) |
Async20Access(Server server,
int period,
boolean initialRefresh) |
Async20Access(Server server,
int period,
boolean initialRefresh,
String logTag) |
SyncAccess(Server server,
int period) |
SyncAccess(Server server,
int period,
String logTag) |
| Modifier and Type | Method and Description |
|---|---|
Branch |
TreeBrowser.browse()
Browse through all levels of the tree browser.
|
Collection<String> |
FlatBrowser.browse() |
protected void |
TreeBrowser.browse(Branch branch,
boolean leaves,
boolean branches,
boolean descend) |
Collection<String> |
FlatBrowser.browse(EnumSet<Access> accessMask) |
protected Collection<String> |
BaseBrowser.browse(OPCBROWSETYPE type,
String filterCriteria,
EnumSet<Access> accessMask,
int variantType)
Perform the browse operation.
|
Collection<String> |
FlatBrowser.browse(String filterCriteria) |
Collection<String> |
FlatBrowser.browse(String filterCriteria,
EnumSet<Access> accessMask,
int variantType)
Perform a flat browse operation
|
Branch |
TreeBrowser.browseBranches()
Browse the root branch for its sub-branches.
|
protected void |
TreeBrowser.browseBranches(Branch branch,
boolean leaves,
boolean descend) |
Branch |
TreeBrowser.browseLeaves()
Browse the root branch for this leaves.
|
protected void |
TreeBrowser.browseLeaves(Branch branch)
Fill the branch object with the leaves of this currently selected branch.
|
void |
TreeBrowser.fill(Branch branch)
Fill the leaves and branches of the branch provided branches including
alls sub-branches.
|
void |
TreeBrowser.fillBranches(Branch branch)
Fill the branch list of the provided branch.
|
void |
TreeBrowser.fillLeaves(Branch branch)
Fill the leaf list of the provided branch.
|
Collection<String> |
BaseBrowser.getAccessPaths(String itemId)
Browse the access paths for one item.
|
protected void |
TreeBrowser.moveToBranch(Branch branch)
Move the tree browser to a branch
|
protected void |
TreeBrowser.moveToRoot()
Move the tree browser to the root folder
|
| Modifier and Type | Method and Description |
|---|---|
String |
ServerList.getClsIdFromProgId(String progId)
Fetch the class id of a prog id
|
ClassDetails |
ServerList.getDetails(String clsId)
Get the details of a opc class
|
Collection<String> |
ServerList.listServers(Category[] implemented,
Category[] required)
List all servers that match the requirements
|
Collection<ClassDetails> |
ServerList.listServersWithDetails(Category[] implemented,
Category[] required)
List all servers that match the requirements and return the class details
|
| Constructor and Description |
|---|
ServerList(JISession session,
String host)
Create a new instance with an already existing session
|
ServerList(String host,
String user,
String password)
Create a new instance and a new DCOM session
|
ServerList(String host,
String user,
String password,
String domain)
Create a new instance and a new DCOM session
|
Copyright © 2017 LSST. All rights reserved.