alma.acsexmplErrorComponent.ErrorComponentImpl

Class ErrorComponentImpl

java.lang.Object

alma.acs.component.ComponentImplBase

alma.acsexmplErrorComponent.ErrorComponentImpl.ErrorComponentImpl

All Implemented Interfaces:

ComponentLifecycle

public class ErrorComponentImpl
extends ComponentImplBase

Implementation of the ErrorComponent interface, which should demonstrate proper use of the ACS error system in Java.

Note on logging: unlike in the C++ implementation of this component, here we do not log the invocation of every method, because the Java container does this automatically. In general the component should only trace the invocations itself if it needs to add custom data to the log.

Author:

hsommer

Field Summary

Fields inherited from class alma.acs.component.ComponentImplBase

m_containerServices, m_instanceName, m_logger

Constructor Summary

Constructors

Constructor and Description
ErrorComponentImpl()

Method Summary

Modifier and Type	Method and Description
void	badMethod(short depth) An intentionally bad method that throws an exception (GenericErrorEx) if depth > 0.
Completion	completionFromCompletion(short depth)
Completion	completionFromException(short depth)
Completion	completionOnStack(short depth) Forwards to completionFromException(short) because in Java we can't create objects on the stack, so there is no distinction to be made.
void	corbaSystemException() An intentionally bad method that throws a CORBA::BAD_PARAM system exception to show how to handle CORBA System Exceptions
void	displayMessage()
void	exceptionFromCompletion(short depth) This method throws a GenericErrorEx exception if the completion returned from internalCompletionMethod(int) has an associated exception.
void	generateSIGFPE(short way)
void	generateSIGSEGV(short way)
void	outCompletion(alma.ACSErr.CompletionHolder comp) this method returns a Completion as an out parameter.
void	sleepingCmd(short nbSeconds)
void	typeException(short depth)

Methods inherited from class alma.acs.component.ComponentImplBase

aboutToAbort, cleanUp, componentState, execute, initialize, name

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorComponentImpl

public ErrorComponentImpl()

Method Detail

displayMessage

public void displayMessage()

badMethod

public void badMethod(short depth)
               throws GenericErrorEx

An intentionally bad method that throws an exception (GenericErrorEx) if depth > 0. This exception has causing exception if depth > 1. All exceptions get added to the ErrorTrace list which will transport them over CORBA.

Note that the thrown CORBA exception GenericErrorEx only acts as a vehicle for the embedded ErrorTrace linked list which contains the real data of the exception(s).

Throws:

GenericErrorEx

See Also:

alma.acsexmplErrorComponent.ErrorComponentOperations#badMethod(short)

corbaSystemException

public void corbaSystemException()
                          throws org.omg.CORBA.SystemException

An intentionally bad method that throws a CORBA::BAD_PARAM system exception to show how to handle CORBA System Exceptions

Throws:

org.omg.CORBA.SystemException

See Also:

alma.acsexmplErrorComponent.ErrorComponentOperations#corbaSystemException()

exceptionFromCompletion

public void exceptionFromCompletion(short depth)
                             throws GenericErrorEx

This method throws a GenericErrorEx exception if the completion returned from internalCompletionMethod(int) has an associated exception. This will be the case if the depth parameter is > 0.

Throws:

GenericErrorEx

See Also:

alma.acsexmplErrorComponent.ErrorComponentOperations#exceptionFromCompletion(short)

typeException

public void typeException(short depth)
                   throws ACSErrTypeCommonEx

Throws:

ACSErrTypeCommonEx

completionFromException

public Completion completionFromException(short depth)

See Also:

alma.acsexmplErrorComponent.ErrorComponentOperations#completionFromException(short)

completionFromCompletion

public Completion completionFromCompletion(short depth)

See Also:

alma.acsexmplErrorComponent.ErrorComponentOperations#completionFromCompletion(short)

completionOnStack

public Completion completionOnStack(short depth)

Forwards to completionFromException(short) because in Java we can't create objects on the stack, so there is no distinction to be made.

See Also:

alma.acsexmplErrorComponent.ErrorComponentOperations#completionOnStack(short)

outCompletion

public void outCompletion(alma.ACSErr.CompletionHolder comp)

this method returns a Completion as an out parameter.

See Also:

alma.acsexmplErrorComponent.ErrorComponentOperations#outCompletion(alma.ACSErr.CompletionHolder)

generateSIGFPE

public void generateSIGFPE(short way)

generateSIGSEGV

public void generateSIGSEGV(short way)

sleepingCmd

public void sleepingCmd(short nbSeconds)