org.diirt.service.exec

Class ExecServiceMethodDescription

java.lang.Object

org.diirt.service.ServiceMethodDescription

org.diirt.service.exec.ExecServiceMethodDescription

public class ExecServiceMethodDescription
extends ServiceMethodDescription

The description for an executor service method (i.e. a shell command).

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
ExecServiceMethodDescription(String name, String description) A new service method with the given name and description.

Method Summary

Modifier and Type	Method and Description
ExecServiceMethodDescription	command(String command) Add a command for the script.
ServiceMethod	createServiceMethod(ServiceDescription serviceDescription) Creates a service method with the given description.
ExecServiceMethodDescription	queryResult(String name, String description) Adds a result for the script; cannot have multiple query results.

Methods inherited from class org.diirt.service.ServiceMethodDescription

addArgument, addResult

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecServiceMethodDescription

public ExecServiceMethodDescription(String name,
                                    String description)

A new service method with the given name and description.

Parameters:

name - the method name; can't be null

description - the method description; can't be null

Method Detail

queryResult

public ExecServiceMethodDescription queryResult(String name,
                                                String description)

Adds a result for the script; cannot have multiple query results.

Parameters:

name - the result name; can't be null

description - the result description; can't be null

Returns:

this

command

public ExecServiceMethodDescription command(String command)

Add a command for the script.

Parameters:

command - the shell command; can't be null

Returns:

this description

createServiceMethod

public ServiceMethod createServiceMethod(ServiceDescription serviceDescription)

Description copied from class: ServiceMethodDescription

Creates a service method with the given description.

A client should implement this to return their service method implementation.

Specified by:

createServiceMethod in class ServiceMethodDescription

Parameters:

serviceDescription - service description for the new service method

Returns:

a new service method