com.goldencode.p2j.comauto

Class ComOleDaemon

java.lang.Object

com.goldencode.p2j.comauto.ComOleDaemon

All Implemented Interfaces:

ComOleOps

public class ComOleDaemon
extends java.lang.Object
implements ComOleOps

Helper methods to handle COM Automation processing. Delegates the calls to ComOleHelper. Exposes these APIs to the server-side via a ComOleOps network server.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.Object	modToken Token used to authenticate with the dispatcher when registering APIs.

Constructor Summary

Constructors

Constructor and Description
ComOleDaemon(boolean local) Create an instance and export its API to the network.

Method Summary

Modifier and Type	Method and Description
BaseDataType[][]	call(long comId, java.lang.String methodName, ComParameter[] aParams) Execute a COM object method call.
long	create(java.lang.String comObjectType, boolean topLevel, boolean noCreate) Obtain a reference to an automation.
java.lang.String	getName(long comId) Get the COM object name associated with the given COM object ID.
BaseDataType	getProperty(long comId, java.lang.String prop, ComParameter[] indices) Get the specified COM object property.
boolean	isSupported() Gets COM Automation support level for particular OS.
void	release(long comId) Release and destroy the COM object with the specified ID.
boolean	setProperty(long comId, java.lang.String prop, ComParameter val, ComParameter[] indices) Set the specified COM object property.

Methods inherited from class java.lang.Object

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

Field Detail

modToken

private static java.lang.Object modToken

Token used to authenticate with the dispatcher when registering APIs.

Constructor Detail

ComOleDaemon

public ComOleDaemon(boolean local)

Create an instance and export its API to the network.

Parameters:

local - true to register purely on a local basis (no remote/network access to these methods).

Method Detail

release

public void release(long comId)

Release and destroy the COM object with the specified ID.

Specified by:

release in interface ComOleOps

Parameters:

comId - The COM object ID.

create

public long create(java.lang.String comObjectType,
                   boolean topLevel,
                   boolean noCreate)

Obtain a reference to an automation. It can be a new instance or a reference to an already existing top-level automation.

Specified by:

create in interface ComOleOps

Parameters:

comObjectType - The name of the automation.

topLevel - Only return top-level. If the requested comObjectType is not a top-level, return null.

noCreate - Must exist. Do not allow creation of new instances. Only used with topLevel requests.

Returns:

The ID of the COM object, or 0 if such automation does not exist or it does not satisfy the parameter constraints.

getProperty

public BaseDataType getProperty(long comId,
                                java.lang.String prop,
                                ComParameter[] indices)

Get the specified COM object property.

Specified by:

getProperty in interface ComOleOps

Parameters:

comId - The COM object ID.

prop - The COM property name to retrieve.

indices - A variable number of indices used to access this property's element.

Returns:

A BaseDataType instance with the COM property's details.

setProperty

public boolean setProperty(long comId,
                           java.lang.String prop,
                           ComParameter val,
                           ComParameter[] indices)

Set the specified COM object property.

Specified by:

setProperty in interface ComOleOps

Parameters:

comId - The COM object ID.

prop - The COM property name to set.

val - The details about property's new value.

indices - A variable number of indices used to access this property's element.

Returns:

true if the property was set successfully.

call

public BaseDataType[][] call(long comId,
                             java.lang.String methodName,
                             ComParameter[] aParams)

Execute a COM object method call.

Specified by:

call in interface ComOleOps

Parameters:

comId - The COM object ID.

methodName - The COM method name to call.

aParams - An array with this call's arguments supplied to the COM object method call.

Returns:

An array where on index 0 are details of the returned value, and further indices correspond with argument's 1-based indices, where there will be a value for each OUTPUT or INPUT-OUTPUT argument.

getName

public java.lang.String getName(long comId)

Get the COM object name associated with the given COM object ID.

Specified by:

getName in interface ComOleOps

Parameters:

comId - The COM object ID.

Returns:

See above.

isSupported

public boolean isSupported()

Gets COM Automation support level for particular OS. Only Windows system has this functionality.

Specified by:

isSupported in interface ComOleOps

Returns:

TRUE if COM objects are supported, FALSE otherwise.