net.juniper.smgt.sae.router.command
Interface CommandChannel

All Known Implementing Classes:

UnsupportedCommandChannel

public interface CommandChannel

This class is used to send command to network device.

Field Summary

static String	SYNTAX_JUNOSCRIPT command channel syntax
static String	SYNTAX_SNMP

Method Summary

String	getCommandSyntax() Get command channel syntax
boolean	isSupported() Check if command channel is available
Response	pushCommand(String command, int timeout) send the command to network device.

Field Detail

SYNTAX_JUNOSCRIPT

static final String SYNTAX_JUNOSCRIPT

command channel syntax

See Also:

Constant Field Values

SYNTAX_SNMP

static final String SYNTAX_SNMP

See Also:

Constant Field Values

Method Detail

pushCommand

Response pushCommand(String command,
                     int timeout)
                     throws CommandException

send the command to network device.

Parameters:

command, - command line for specific network device, e.g. for Junos router, it should be Junos script in XML format.

timeout, - time out before response arrived, if it is -1, the router default timeout will be used.

Returns:

Response, the response message from network device.

Throws:

CommandException, - thrown if anything failed.

CommandException

isSupported

boolean isSupported()

Check if command channel is available

Returns:

true if command channel is available

getCommandSyntax

String getCommandSyntax()

Get command channel syntax

Returns:

one of the command syntax e.g. 'JUNOScript', 'JUNOSe_SNMP'