oracle.axia.api.management.pac

Interface ProtocolAdapterMBean

public interface ProtocolAdapterMBean

Defines the runtime MBean for a Protocol Adapter.

Author:

Copyright (c) 2009 by Oracle Corp. All Rights Reserved.

Method Summary

Modifier and Type	Method and Description
void	forceSuspend() Forcefully suspends the adapter.
java.lang.String	getInstanceId() Gets the protocol adapter instance id.
java.lang.String	getState() Gets the protocol adapter state.
void	resume() Resumes the adapter.
void	suspend() Suspends the adapter.

Method Detail

getInstanceId

java.lang.String getInstanceId()

Gets the protocol adapter instance id.

Returns:

id.

getState

java.lang.String getState()

Gets the protocol adapter state.

Returns:

REGISTERED, ADMIN, RUNNING_CONNECTED, RUNNING_DISCONNECTED, SUSPENDING.

resume

void resume()
     throws java.lang.IllegalStateException

Resumes the adapter.

Throws:

java.lang.IllegalStateException - If resume can not be performed in this state.

suspend

void suspend()
      throws java.lang.IllegalStateException

Suspends the adapter. Note that the adapter is suspended asynchronously. Use getState attribute to monitor completion of the suspend.

Throws:

java.lang.IllegalStateException - If suspend can not be performed in this state.

forceSuspend

void forceSuspend()
           throws java.lang.IllegalStateException

Forcefully suspends the adapter.

Throws:

java.lang.IllegalStateException - If suspend can not be performed in this state.