Package org.jupnp.controlpoint

Klasse ActionCallback

java.lang.Object

org.jupnp.controlpoint.ActionCallback

Alle implementierten Schnittstellen:

Runnable

Bekannte direkte Unterklassen:

ActionCallback.Default

public abstract class ActionCallback
extends Object
implements Runnable

Execute actions on any service.

Usage example for asynchronous execution in a background thread:

 Service service = device.findService(new UDAServiceId("SwitchPower"));
 Action getStatusAction = service.getAction("GetStatus");
 ActionInvocation getStatusInvocation = new ActionInvocation(getStatusAction);

 ActionCallback getStatusCallback = new ActionCallback(getStatusInvocation) {

      public void success(ActionInvocation invocation) {
          ActionArgumentValue status  = invocation.getOutput("ResultStatus");
          assertEquals((Boolean) status.getValue(), Boolean.valueOf(false));
      }

      public void failure(ActionInvocation invocation, UpnpResponse res) {
          System.err.println(
              createDefaultFailureMessage(invocation, res)
          );
      }
 };

 upnpService.getControlPoint().execute(getStatusCallback)
 

You can also execute the action synchronously in the same thread using the ActionCallback.Default implementation:

 myActionInvocation.setInput("foo", bar);
 new ActionCallback.Default(myActionInvocation, upnpService.getControlPoint()).run();
 myActionInvocation.getOutput("baz");
 

Autor:

Christian Bauer

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static final class	ActionCallback.Default	Empty implementation of callback methods, simplifies synchronous execution of an ActionInvocation.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected final ActionInvocation	actionInvocation
protected ControlPoint	controlPoint

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	ActionCallback(ActionInvocation actionInvocation)
protected	ActionCallback(ActionInvocation actionInvocation, ControlPoint controlPoint)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected String	createDefaultFailureMessage(ActionInvocation invocation, UpnpResponse operation)
protected void	failure(ActionInvocation invocation, UpnpResponse operation)
abstract void	failure(ActionInvocation invocation, UpnpResponse operation, String defaultMsg)	Called when the action invocation failed.
ActionInvocation	getActionInvocation()
ControlPoint	getControlPoint()
void	run()
ActionCallback	setControlPoint(ControlPoint controlPoint)
abstract void	success(ActionInvocation invocation)	Called when the action invocation succeeded.
String	toString()

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

actionInvocation

protected final ActionInvocation actionInvocation

controlPoint

protected ControlPoint controlPoint

Konstruktordetails

ActionCallback

protected ActionCallback(ActionInvocation actionInvocation,
 ControlPoint controlPoint)

ActionCallback

protected ActionCallback(ActionInvocation actionInvocation)

Methodendetails

getActionInvocation

public ActionInvocation getActionInvocation()

getControlPoint

public ControlPoint getControlPoint()

setControlPoint

public ActionCallback setControlPoint(ControlPoint controlPoint)

run

public void run()

Angegeben von:

run in Schnittstelle Runnable

createDefaultFailureMessage

protected String createDefaultFailureMessage(ActionInvocation invocation,
 UpnpResponse operation)

failure

protected void failure(ActionInvocation invocation,
 UpnpResponse operation)

success

public abstract void success(ActionInvocation invocation)

Called when the action invocation succeeded.

Parameter:

invocation - The successful invocation, call its getOutput() method for results.

failure

public abstract void failure(ActionInvocation invocation,
 UpnpResponse operation,
 String defaultMsg)

Called when the action invocation failed.

Parameter:

invocation - The failed invocation, call its getFailure() method for more details.

operation - If the invocation was on a remote service, the response message, otherwise null.

defaultMsg - A user-friendly error message generated from the invocation exception and response.

Siehe auch:

• createDefaultFailureMessage(org.jupnp.model.action.ActionInvocation, org.jupnp.model.message.UpnpResponse)

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object