Index (jNut client library 1.1 API)

A B C D E F G H I L M N O Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

authenticate() - Method in class org.networkupstools.jnut.Client: Intend to authenticate with an already set login and password.
authenticate(String, String) - Method in class org.networkupstools.jnut.Client: Intend to authenticate with a specified login and password, overriding already defined ones (remembers them as class instance fields).

B

becomePrimary() - Method in class org.networkupstools.jnut.Device: This function does little by itself.

C

certVerify - Variable in class org.networkupstools.jnut.SSLConfig
Client - Class in org.networkupstools.jnut: A jNut client is the starting point to the dialog to UPSD.
Client() - Constructor for class org.networkupstools.jnut.Client: Default constructor.
Client(String, int, String, String) - Constructor for class org.networkupstools.jnut.Client: Connection constructor.
Command - Class in org.networkupstools.jnut: Class representing a command of a device.
Command(String, Device) - Constructor for class org.networkupstools.jnut.Command: Internally create a command.
connect() - Method in class org.networkupstools.jnut.Client: Connection to UPSD with already specified parameters (including a call to Client.authenticate(String, String) if so configured).
connect(String, int) - Method in class org.networkupstools.jnut.Client: Intent to connect to an UPSD with specified parameters (remembers them as class instance fields) without authentication.
connect(String, int, String, String) - Method in class org.networkupstools.jnut.Client: Intent to connect and authenticate to an UPSD with specified parameters (remembers them as class instance fields).
createContext() - Method in class org.networkupstools.jnut.SSLConfig_JKS
createContext() - Method in class org.networkupstools.jnut.SSLConfig

D

Device - Class in org.networkupstools.jnut: Class representing a device attached to a Client session.
Device(String, Client) - Constructor for class org.networkupstools.jnut.Device: Internally create a device.
disconnect() - Method in class org.networkupstools.jnut.Client: Disconnect.
DriverNotConnected - Static variable in exception class org.networkupstools.jnut.NutException

E

enableTrackingModeOnce() - Method in class org.networkupstools.jnut.Client: Enable TRACKING mode on this connection if it is not already enabled.
equals(Object) - Method in class org.networkupstools.jnut.TrackingID
execute() - Method in class org.networkupstools.jnut.Command: Execute the instant command without any optional argument.
execute(String) - Method in class org.networkupstools.jnut.Command: Execute the instant command with an optional parameter.
execute(String, int, int) - Method in class org.networkupstools.jnut.Command: Execute the instant command with an optional parameter, and optionally waiting for completion.
extra - Variable in exception class org.networkupstools.jnut.NutException

F

forceSSL - Variable in class org.networkupstools.jnut.SSLConfig

G

get(String, String) - Method in class org.networkupstools.jnut.Client: Send a GET query line, then read the reply and validate the response.
get(String, String[]) - Method in class org.networkupstools.jnut.Client: Send a GET query line, then read the reply and validate the response.
getAge() - Method in class org.networkupstools.jnut.TrackingID
getClient() - Method in class org.networkupstools.jnut.Device: Return the client to which the device is connected.
getClients() - Method in class org.networkupstools.jnut.Device: Return the list of clients which have done LOGIN for this UPS.
getCommand(String) - Method in class org.networkupstools.jnut.Device: Return a command from its name.
getCommandList() - Method in class org.networkupstools.jnut.Device: Return the list of device commands from the NUT server.
getConfig() - Method in class org.networkupstools.jnut.Scanner: Retrieve scanner extra parameters like snmp community name or passwords.
getCreated() - Method in class org.networkupstools.jnut.TrackingID
getDescription() - Method in class org.networkupstools.jnut.Command: Retrieve the command description from UPSD and store it in a cache.
getDescription() - Method in class org.networkupstools.jnut.Device: Retrieve the device description from UPSD and store it in a cache.
getDescription() - Method in class org.networkupstools.jnut.Variable: Retrieve the variable description from UPSD and store it in a cache.
getDevice() - Method in class org.networkupstools.jnut.Command: Return the device to which the command can be executed.
getDevice() - Method in class org.networkupstools.jnut.Variable: Return the device to which the variable is related.
getDevice(String) - Method in class org.networkupstools.jnut.Client: Intend to retrieve a device by its name.
getDeviceList() - Method in class org.networkupstools.jnut.Client: Returns the list of available devices from the NUT server.
getDriver() - Method in class org.networkupstools.jnut.Scanner.DiscoveredDevice: Retrieve the name of the driver used by the device.
getEnumList() - Method in class org.networkupstools.jnut.Variable: Retrieve the list of possible values for an ENUM variable.
getExecName() - Method in class org.networkupstools.jnut.Scanner: Retrieve nut-scanner executable name (with location if any).
getExecPath() - Method in class org.networkupstools.jnut.Scanner: Retrieve the nut-scanner executable path.
getExtra() - Method in exception class org.networkupstools.jnut.NutException: Returns the extra message.
getHost() - Method in class org.networkupstools.jnut.Client: Get the host name or address to which the client is (or will be) connected.
getId() - Method in class org.networkupstools.jnut.TrackingID
getLastTrackingId() - Method in class org.networkupstools.jnut.Client: Get the tracking ID for last SET or INSTCMD.
getLogin() - Method in class org.networkupstools.jnut.Client: Get the login with which the client is (or will be connected).
getName() - Method in class org.networkupstools.jnut.Command: Return the command name.
getName() - Method in class org.networkupstools.jnut.Device: Return the device name.
getName() - Method in class org.networkupstools.jnut.Variable: Return the variable name.
getNumLogin() - Method in class org.networkupstools.jnut.Device: Return the number of clients which have done LOGIN for this UPS.
getParam(String) - Method in class org.networkupstools.jnut.Scanner: Retrieve a scanner extra parameter.
getPasswd() - Method in class org.networkupstools.jnut.Client: Get the password with which the client is (or will be connected).
getPort() - Method in class org.networkupstools.jnut.Client: Get the port to which the client is (or will be) connected.
getProperties() - Method in class org.networkupstools.jnut.Scanner.DiscoveredDevice: Retrieve the map of device properties.
getProperty(String) - Method in class org.networkupstools.jnut.Scanner.DiscoveredDevice: Retrieve a device property if exists.
getRangeList() - Method in class org.networkupstools.jnut.Variable: Retrieve the list of possible ranges for a RANGE variable.
getRWVariableList() - Method in class org.networkupstools.jnut.Device: Return the list of device RW variables from the NUT server.
getScanType() - Method in class org.networkupstools.jnut.Scanner: Retrieve the scan type.
getSslConfig() - Method in class org.networkupstools.jnut.Client
getTrackingResult(TrackingID) - Method in class org.networkupstools.jnut.Client
getType() - Method in class org.networkupstools.jnut.Variable: Retrieve the variable type from UPSD.
getValue() - Method in class org.networkupstools.jnut.Variable: Retrieve the variable value from UPSD and store it in a cache.
getVariable(String) - Method in class org.networkupstools.jnut.Device: Return a variable from its name.
getVariableList() - Method in class org.networkupstools.jnut.Device: Return the list of device variables from the NUT server.

H

hashCode() - Method in class org.networkupstools.jnut.TrackingID
hasParam(String) - Method in class org.networkupstools.jnut.Scanner: Test if a scanner has an extra parameter.
hasProperty(String) - Method in class org.networkupstools.jnut.Scanner.DiscoveredDevice: Test if the device has a property.

I

is(String) - Method in exception class org.networkupstools.jnut.NutException: Test is the exception corresponds to the specified well-known problem name.
isCertVerify() - Method in class org.networkupstools.jnut.SSLConfig
isConnected() - Method in class org.networkupstools.jnut.Client: Test if the client is connected to the UPSD.
isForceSSL() - Method in class org.networkupstools.jnut.SSLConfig
isTrackingEnabled() - Method in class org.networkupstools.jnut.Client: Get the tracking activation status.
isValid() - Method in class org.networkupstools.jnut.TrackingID
isValidProtocolVersion() - Method in class org.networkupstools.jnut.Client: Query the (already established) connection to UPSD for its version.
isValidProtocolVersion(String) - Method in class org.networkupstools.jnut.Client: Query the (already established) connection to UPSD for its version and check it against given expectations.

L

list(String) - Method in class org.networkupstools.jnut.Client: Send a LIST query line, then read replies and validate them.
list(String, String) - Method in class org.networkupstools.jnut.Client: Send a LIST query line, then read replies and validate them.
list(String, String[]) - Method in class org.networkupstools.jnut.Client: Send a LIST query line, then read replies and validate them.
login() - Method in class org.networkupstools.jnut.Device: Log in to the UPS to assume a special role which matters to orchestration of the server lifecycle and its other clients.
logout() - Method in class org.networkupstools.jnut.Client: Log out.

M

master() - Method in class org.networkupstools.jnut.Device: Deprecated.
Use Device.becomePrimary() instead

N

NutException - Exception Class in org.networkupstools.jnut: Class representing a NUT exception.
NutException() - Constructor for exception class org.networkupstools.jnut.NutException
NutException(String) - Constructor for exception class org.networkupstools.jnut.NutException
NutException(String, String) - Constructor for exception class org.networkupstools.jnut.NutException
NutException(String, String, Throwable) - Constructor for exception class org.networkupstools.jnut.NutException
NutException(String, Throwable) - Constructor for exception class org.networkupstools.jnut.NutException
NutException(Throwable) - Constructor for exception class org.networkupstools.jnut.NutException

O

OPTION_END_IP - Static variable in class org.networkupstools.jnut.Scanner
OPTION_MASK_CIDR - Static variable in class org.networkupstools.jnut.Scanner
OPTION_NUT_UPSD_PORT - Static variable in class org.networkupstools.jnut.Scanner
OPTION_SCANNER_EXEC - Static variable in class org.networkupstools.jnut.Scanner
OPTION_SCANNER_PATH - Static variable in class org.networkupstools.jnut.Scanner
OPTION_SNMPv1_COMMUNITY - Static variable in class org.networkupstools.jnut.Scanner
OPTION_SNMPv3_AUTHENTICATION_PASSWORD - Static variable in class org.networkupstools.jnut.Scanner
OPTION_SNMPv3_AUTHENTICATION_PROTOCOL - Static variable in class org.networkupstools.jnut.Scanner
OPTION_SNMPv3_PRIVACY_PASSWORD - Static variable in class org.networkupstools.jnut.Scanner
OPTION_SNMPv3_PRIVACY_PROTOCOL - Static variable in class org.networkupstools.jnut.Scanner
OPTION_SNMPv3_SECURITY_LEVEL - Static variable in class org.networkupstools.jnut.Scanner
OPTION_SNMPv3_SECURITY_NAME - Static variable in class org.networkupstools.jnut.Scanner
OPTION_START_IP - Static variable in class org.networkupstools.jnut.Scanner
OPTION_TIMEOUT - Static variable in class org.networkupstools.jnut.Scanner
org.networkupstools.jnut - package org.networkupstools.jnut

Q

query(String) - Method in class org.networkupstools.jnut.Client: Send a query line, then read the response.
query(String, String) - Method in class org.networkupstools.jnut.Client: Send a query line, then read the response.
query(String, String[]) - Method in class org.networkupstools.jnut.Client: Send a query line, then read the response.
query(String, String, String[]) - Method in class org.networkupstools.jnut.Client: Send a query line, then read the response.

R

removeParam(String) - Method in class org.networkupstools.jnut.Scanner: Remove a scanner extra parameter.

S

scan() - Method in class org.networkupstools.jnut.Scanner: Execute the scan.
SCAN_AVAHI - Static variable in class org.networkupstools.jnut.Scanner
SCAN_COMPLETE - Static variable in class org.networkupstools.jnut.Scanner
SCAN_IPMI - Static variable in class org.networkupstools.jnut.Scanner
SCAN_OLDNUT - Static variable in class org.networkupstools.jnut.Scanner
SCAN_SNMP - Static variable in class org.networkupstools.jnut.Scanner
SCAN_USB - Static variable in class org.networkupstools.jnut.Scanner
SCAN_XML - Static variable in class org.networkupstools.jnut.Scanner
Scanner - Class in org.networkupstools.jnut: jNut scanner.
Scanner() - Constructor for class org.networkupstools.jnut.Scanner: Default constructor (scan for all device types).
Scanner(int) - Constructor for class org.networkupstools.jnut.Scanner: Constructor with device types.
Scanner(int, Map) - Constructor for class org.networkupstools.jnut.Scanner: Constructor with device types and scan parameters.
Scanner.DiscoveredDevice - Class in org.networkupstools.jnut: Result of a scan.
ServerNotConnected - Static variable in exception class org.networkupstools.jnut.NutException: Not a NUT message, but internal report when Client.isConnected() returns false during a query (preparing to `get`, etc.)
setConfig(Map) - Method in class org.networkupstools.jnut.Scanner: Set the scanner extra parameters.
setExecName(String) - Method in class org.networkupstools.jnut.Scanner: Set the nut-scanner executable name (with location if any).
setExecPath(String) - Method in class org.networkupstools.jnut.Scanner: Set the nut-scanner executable path.
setExtra(String) - Method in exception class org.networkupstools.jnut.NutException: Set the extra message.
setForcedShutdown() - Method in class org.networkupstools.jnut.Device: Set the "forced shutdown" flag.
setHost(String) - Method in class org.networkupstools.jnut.Client: Set the host name (or address) to which the client will intend to connect to at the next connection.
setLogin(String) - Method in class org.networkupstools.jnut.Client: Set the login with which the client will intend to connect.
setParam(String, String) - Method in class org.networkupstools.jnut.Scanner: Set a scanner extra parameter.
setPasswd(String) - Method in class org.networkupstools.jnut.Client: Set the password with which the client will intend to connect.
setPort(int) - Method in class org.networkupstools.jnut.Client: Set the port to which the client is (or will be) connected.
setScanType(int) - Method in class org.networkupstools.jnut.Scanner: Set the scan type.
setSslConfig(SSLConfig) - Method in class org.networkupstools.jnut.Client: Set the SSL configuration for the client; should do so before calling Client.connect(String, int, String, String).
setTracking(boolean) - Method in class org.networkupstools.jnut.Client: Set the tracking activation status; requires that the client connection is already active (call this after Client.connect(String, int, String, String) succeeds).
setValue(String) - Method in class org.networkupstools.jnut.Variable: Set the variable value.
setValue(String, int, int) - Method in class org.networkupstools.jnut.Variable: Set the variable value, optionally waiting for completion.
SSLConfig - Class in org.networkupstools.jnut: Base class of SSL configuration for NUT connections.
SSLConfig(boolean, boolean) - Constructor for class org.networkupstools.jnut.SSLConfig
SSLConfig_JKS - Class in org.networkupstools.jnut: SSL configuration with added options specific for Java KeyStore (JKS/PKCS12).
SSLConfig_JKS(boolean, boolean, String, String, String, String) - Constructor for class org.networkupstools.jnut.SSLConfig_JKS

T

toString() - Method in exception class org.networkupstools.jnut.NutException: Format an exception message.
toString() - Method in class org.networkupstools.jnut.TrackingID
TrackingID - Class in org.networkupstools.jnut: Cookie given when performing async action, used to redeem the result at a later date.
TrackingID(String) - Constructor for class org.networkupstools.jnut.TrackingID

U

UnknownResponse - Static variable in exception class org.networkupstools.jnut.NutException

V

Variable - Class in org.networkupstools.jnut: Class representing a variable of a device.
Variable(String, Device) - Constructor for class org.networkupstools.jnut.Variable: Internally create a variable.

W

waitTrackingResult(TrackingID, int, int) - Method in class org.networkupstools.jnut.Client: Wait for a tracking ID to complete.

A B C D E F G H I L M N O Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form