alma.acs.exceptions

Class AcsJCompletion

java.lang.Object

alma.acs.exceptions.AcsJCompletion

Direct Known Subclasses:

Objects.MyAcsJCompletion

public class AcsJCompletion
extends java.lang.Object

Java class that facilitates working with the interoperable Completion that's generated from CORBA IDL.

A Completion transmits the result of a remote method invocation to the client. It contains an error type and code as defined in the ACS framework, as well as an optional ErrorTrace. Note that for asynchronous calls, it is not possible to transmit thrown exceptions to the client directly; here the Completion fills the gap.

Similar to AcsJException, AcsJCompletion converts CORBA struct data into its nicer Java representation upon construction. When an AcsJCompletion must be transported further on over CORBA, the method toCorbaCompletion() will create a corresponding Completion with correct ErrorTrace structs attached.

For any combination of error type/code, the ACS framework generates subclasses of AcsJCompletion, which ensure usage of the correct type and code.

• To create a completion object from scratch, use the appropriate subclass;
• To create a completion from the base type AcsJException, which may be useful inside a catch block, use AcsJException.toAcsJCompletion().
• To convert an existing CORBA Completion to an AcsJCompletion, use the static method fromCorbaCompletion(Completion).

Author:

hsommer created Jan 20, 2004 3:11:34 PM

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Properties	m_properties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AcsJCompletion()
protected	AcsJCompletion(AcsJException acsJEx) To be called from ctors of generated subclasses that have exceptions attached.
protected	AcsJCompletion(int type, int code) To be called from ctors of generated subclasses that can't have exceptions attached.

Method Summary

Modifier and Type	Method and Description
static AcsJCompletion	fromCorbaCompletion(Completion corbaCompletion) Factory method to create an AcsJCompletion from an existing CORBA completion.
AcsJException	getAcsJException()
int	getCode() Returns the completion code.
java.lang.String	getProperty(java.lang.String key)
long	getTimeStamp() Returns the timeStamp.
int	getType() Returns the completion type.
protected void	init(AcsJException acsJEx) Initializes this AcsJCompletion object with the data of an AcsJException (chain).
protected void	init(int type, int code)
boolean	isError() True if this completion represents an error condition.
java.lang.Object	setProperty(java.lang.String key, java.lang.String value) Allows extra information to be attached to the completion, but only if this completion represents an error.
Completion	toCorbaCompletion() Creates a CORBA style completion object from this Java style completion.

Methods inherited from class java.lang.Object

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

Field Detail

m_properties

protected java.util.Properties m_properties

Constructor Detail

AcsJCompletion

protected AcsJCompletion()

AcsJCompletion

protected AcsJCompletion(int type,
                         int code)

To be called from ctors of generated subclasses that can't have exceptions attached.

Parameters:

type -

code -

AcsJCompletion

protected AcsJCompletion(AcsJException acsJEx)

To be called from ctors of generated subclasses that have exceptions attached.

Parameters:

acsJEx -

Method Detail

init

protected void init(int type,
                    int code)

init

protected void init(AcsJException acsJEx)

Initializes this AcsJCompletion object with the data of an AcsJException (chain).

Type, code, and timestamp are taken from acsJEx.

Parameters:

acsJEx -

Throws:

java.lang.NullPointerException - if acsJEx is null.

getType

public int getType()

Returns the completion type.

getCode

public int getCode()

Returns the completion code.

getTimeStamp

public long getTimeStamp()

Returns the timeStamp.

isError

public boolean isError()

True if this completion represents an error condition. The error information can be obtained from getAcsJException().

getAcsJException

public AcsJException getAcsJException()

Returns:

an exception (chain) corresponding to the ErrorTrace, or null if the completion does not correspond to an exception.

See Also:

isError()

toCorbaCompletion

public Completion toCorbaCompletion()

Creates a CORBA style completion object from this Java style completion. If present, the attached exceptions are converted to ErrorTraces.

This method should be used when a Java implementation (of a component etc) has to send an AcsJCompletion over Corba.

See Also:

fromCorbaCompletion(Completion)

fromCorbaCompletion

public static AcsJCompletion fromCorbaCompletion(Completion corbaCompletion)

Factory method to create an AcsJCompletion from an existing CORBA completion. Note that the new AcsJCompletion is a direct translation, not a wrapper.

If corbaCompletion has error information attached, this will be converted, and type/code of the top-exception will have precedence over type/code stored redundantly in corbaCompletion.

To be used on the client side of a remote call.

Parameters:

completion -

setProperty

public java.lang.Object setProperty(java.lang.String key,
                                    java.lang.String value)

Allows extra information to be attached to the completion, but only if this completion represents an error.

Returns:

the previous value of the specified key in this property list, or null if it did not have one.

Throws:

java.lang.IllegalStateException - if this completion has no exceptions attached (i.e. it is an "ok-completion"). TODO: modify ACS error system to allow properties also for ok-completions.

getProperty

public java.lang.String getProperty(java.lang.String key)

See Also:

setProperty(java.lang.String, java.lang.String)