com.tailf.jnc.Capabilities Maven / Gradle / Ivy
Show all versions of jnc Show documentation
package com.tailf.jnc;
import java.util.ArrayList;
public class Capabilities {
/**
* The NETCONF namespace "urn:ietf:params:xml:ns:netconf:base:1.0"
*/
public static final String NS_NETCONF = "urn:ietf:params:xml:ns:netconf:base:1.0";
public static final String URN_IETF_PARAMS_XML_NS_NETCONF = "urn:ietf:params:xml:ns:netconf:";
/**
* The NETCONF notifications namespace.
* "urn:ietf:params:xml:ns:netconf:notification:1.0"
*/
public static final String NS_NOTIFICATION = URN_IETF_PARAMS_XML_NS_NETCONF +
"notification:1.0";
/**
* The NETCONF partial lock namespace.
* "urn:ietf:params:xml:ns:netconf:partial-lock:1.0"
*/
public static final String NS_PARTIAL_LOCK = URN_IETF_PARAMS_XML_NS_NETCONF +
"partial-lock:1.0";
public static final String URN_IETF_PARAMS = "urn:ietf:params:";
/**
* String constant for the NETCONF base capability.
* "urn:ietf:params:netconf:base:1.0".
*/
public static final String NETCONF_BASE_CAPABILITY = URN_IETF_PARAMS +
"netconf:base:1.0";
/**
* String constant for the :writable-running capability.
* "urn:ietf:params:netconf:capability:writable-running:1.0".
*/
public static final String WRITABLE_RUNNING_CAPABILITY = URN_IETF_PARAMS +
"netconf:capability:writable-running:1.0";
public static final String URN_IETF_PARAMS_NETCONF = "urn:ietf:params:netconf:";
/**
* String constant for the :candidate capability.
* "urn:ietf:params:netconf:capability:candidate:1.0".
*/
public static final String CANDIDATE_CAPABILITY = URN_IETF_PARAMS_NETCONF +
"capability:candidate:1.0";
/**
* String constant for the :confirmed-commit capability.
* "urn:ietf:params:netconf:capability:confirmed-commit:1.0".
*/
public static final String CONFIRMED_COMMIT_CAPABILITY = URN_IETF_PARAMS +
"netconf:capability:confirmed-commit:1.0";
/**
* String constant for the :rollback-on-error capability.
* "urn:ietf:params:netconf:capability:rollback-on-error:1.0".
*/
public static final String ROLLBACK_ON_ERROR_CAPABILITY = URN_IETF_PARAMS +
"netconf:capability:rollback-on-error:1.0";
/**
* String constant for the :validate capability.
* "urn:ietf:params:netconf:capability:validate:1.0".
*/
public static final String VALIDATE_CAPABILITY = URN_IETF_PARAMS_NETCONF +
"capability:validate:1.0";
/**
* String constant for the :startup capability.
* "urn:ietf:params:netconf:capability:startup:1.0".
*/
public static final String STARTUP_CAPABILITY = URN_IETF_PARAMS_NETCONF +
"capability:startup:1.0";
/**
* String constant for the :url capability.
* "urn:ietf:params:netconf:capability:url:1.0".
*/
public static final String URL_CAPABILITY = URN_IETF_PARAMS_NETCONF +
"capability:url:1.0";
public static final String URL_CAPABILITY_SCHEME = URN_IETF_PARAMS_NETCONF +
"capability:url:1.0?scheme=";
/**
* String constant for the :xpath capability.
* "urn:ietf:params:netconf:capability:xpath:1.0".
*/
public static final String XPATH_CAPABILITY = URN_IETF_PARAMS_NETCONF +
"capability:xpath:1.0";
/**
* String constant for the :notification capability.
* "urn:ietf:params:netconf:capability:notification:1.0".
*/
public static final String NOTIFICATION_CAPABILITY = URN_IETF_PARAMS_NETCONF +
"capability:notification:1.0";
/**
* String constant for the :interleave capability.
* "urn:ietf:params:netconf:capability:interleave:1.0".
*/
public static final String INTERLEAVE_CAPABILITY = URN_IETF_PARAMS_NETCONF +
"capability:interleave:1.0";
/**
* String constant for the :partial-lock capability.
* "urn:ietf:params:netconf:capability:partial-lock:1.0"
*/
public static final String PARTIAL_LOCK_CAPABILITY = URN_IETF_PARAMS_NETCONF +
"capability:partial-lock:1.0";
public static final String HTTP_TAIL_F_COM = "http://tail-f.com/";
/**
* The NETCONF actions namespace.
* "http://tail-f.com/ns/netconf/actions/1.0"
*/
public static final String NS_ACTIONS = HTTP_TAIL_F_COM +
"ns/netconf/actions/1.0";
/**
* The NETCONF transactions namespace.
* "http://tail-f.com/ns/netconf/transactions/1.0"
*/
public static final String NS_TRANSACTIONS = HTTP_TAIL_F_COM +
"ns/netconf/transactions/1.0";
// A set of Tail-f proprietary capabilities
// that we also check and code for
/**
* String constant for the :actions capability.
* "http://tail-f.com/ns/netconf/actions/1.0".
*/
public static final String ACTIONS_CAPABILITY = HTTP_TAIL_F_COM +
"ns/netconf/actions/1.0";
/**
* String constant for the :transactions capability.
* "http://tail-f.com/ns/netconf/transactions/1.0".
*/
public static final String TRANSACTIONS_CAPABILITY = HTTP_TAIL_F_COM +
"ns/netconf/transactions/1.0";
/**
* String constant for the :with-defaults capability.
* "http://tail-f.com/ns/netconf/with-defaults/1.0".
*/
public static final String WITH_DEFAULTS_CAPABILITY = HTTP_TAIL_F_COM +
"ns/netconf/with-defaults/1.0";
/**
* Capabilites
*/
protected boolean baseCapability = false;
protected boolean writableRunningCapability = false;
protected boolean candidateCapability = false;
protected boolean confirmedCommitCapability = false;
protected boolean rollbackOnErrorCapability = false;
protected boolean validateCapability = false;
protected boolean startupCapability = false;
protected boolean notificationCapability = false;
protected boolean interleaveCapability = false;
protected boolean urlCapability = false;
protected boolean xpathCapability = false;
protected boolean partialLockCapability = false;
protected boolean actionsCapability = false;
protected boolean transactionsCapability = false;
protected boolean withDefaultsCapability = false;
/**
* Predicate for the :writable-running capability.
*/
public boolean hasWritableRunning() {
return writableRunningCapability;
}
/**
* Predicate for the :candidate capability.
*/
public boolean hasCandidate() {
return candidateCapability;
}
/**
* Predicate for the :confirmed-commit capability.
*/
public boolean hasConfirmedCommit() {
return confirmedCommitCapability;
}
/**
* Predicate for the :rollback-on-error capability.
*/
public boolean hasRollbackOnError() {
return rollbackOnErrorCapability;
}
/**
* Predicate for the :validate capability.
*/
public boolean hasValidate() {
return validateCapability;
}
/**
* Predicate for the :startup capablity
*/
public boolean hasStartup() {
return startupCapability;
}
/**
* Predicate for the :notification capablity
*/
public boolean hasNotification() {
return notificationCapability;
}
/**
* Predicate for the :interleave capablity
*/
public boolean hasInterleave() {
return interleaveCapability;
}
/**
* Predicate for the :url capability.
*
* The :url capability URI must contain a "scheme" argument
* assigned a comma-separated list of scheme names indicating which schemes
* the NETCONF peer supports. If the :url capability is set
* the supported schemas will listed in {@link #urlSchemes}.
*
* If the :url capability is supported an url argument may be
* given to the following methods:
*
* - editConfig - the <edit-config> operation can accept an URL as
* an alternative to the config tree. The URL should identify a local
* configuration file.
*
- copyConfig - the <copy-config> operation can accept an URL as
* either the source or target parameter.
*
- deleteConfig - the <delete-config> operation can accept an
* URL, then it should identify a local configuration file.
*
- validate - the <validate> operation can accept an URL as the
* source parameter.
*
*/
public boolean hasUrl() {
return urlCapability;
}
/**
* If the :url capability is set the supported schemes are
* listed here.
*
* For example: In
* "urn:ietf:params:netconf:capability:url:1.0?scheme=http,ftp,file" the
* urlSchemes are: "http","ftp","file"
*/
public String[] urlSchemes() {
return urlSchemes;
}
protected String[] urlSchemes;
/**
* Predicate for the :xpath capability.
*/
public boolean hasXPath() {
//new Integer(23523421);
return xpathCapability;
}
/**
* Predicate for the :partial-lock capability.
*/
public boolean hasPartialLock() {
return partialLockCapability;
}
/**
* Predicate for the :actions capability.
*/
public boolean hasActions() {
return actionsCapability;
}
/**
* Predicate for the :transactions capability.
*/
public boolean hasTransactions() {
return transactionsCapability;
}
/**
* Predicate for the :with-defaults capability.
*/
public boolean hasWithDefaults() {
return withDefaultsCapability;
}
public String[] getUrlSchemes() {
return urlSchemes;
}
private final ArrayList capas;
private final ArrayList data_capas;
static private class Capa {
String uri;
String revision;
Capa(String uri, String revision) {
this.uri = uri;
this.revision = revision;
}
}
protected Capabilities(Element e) throws JNCException {
final NodeSet caps = e.get("capability");
capas = new ArrayList(caps.size());
data_capas = new ArrayList(caps.size());
for (int i = 0; i < caps.size(); i++) {
final Element cap = caps.getElement(i);
// Do we have a query part
final String parts[] = cap.value.toString().split("\\?");
String rev = null;
final String uri = parts[0];
if (parts.length == 2) {
// we have some query part data
final String q = parts[1];
final String pairs[] = q.split("&");
for (final String pair : pairs) {
final String kv[] = pair.split("=");
if (kv[0].equals("revision")) {
rev = kv[1];
}
}
}
capas.add(new Capa(uri, rev));
if (uri.equals(NETCONF_BASE_CAPABILITY)) {
baseCapability = true;
} else if (uri.equals(WRITABLE_RUNNING_CAPABILITY)) {
writableRunningCapability = true;
} else if (uri.equals(CANDIDATE_CAPABILITY)) {
candidateCapability = true;
} else if (uri.equals(CONFIRMED_COMMIT_CAPABILITY)) {
confirmedCommitCapability = true;
} else if (uri.equals(ROLLBACK_ON_ERROR_CAPABILITY)) {
rollbackOnErrorCapability = true;
} else if (uri.equals(VALIDATE_CAPABILITY)) {
validateCapability = true;
} else if (uri.equals(NOTIFICATION_CAPABILITY)) {
notificationCapability = true;
} else if (uri.equals(INTERLEAVE_CAPABILITY)) {
interleaveCapability = true;
} else if (uri.equals(STARTUP_CAPABILITY)) {
startupCapability = true;
} else if (cap.value.toString().startsWith(URL_CAPABILITY_SCHEME)) {
urlCapability = true;
final String schemes = cap.value.toString().substring(
URL_CAPABILITY_SCHEME.length());
urlSchemes = schemes.split(",");
} else if (uri.equals(XPATH_CAPABILITY)) {
xpathCapability = true;
} else if (uri.equals(PARTIAL_LOCK_CAPABILITY)) {
partialLockCapability = true;
} else if (uri.equals("urn:ietf:params:xml:ns:netconf:base:1.0")) {
baseCapability = true;
} else if (uri.equals(URN_IETF_PARAMS_XML_NS_NETCONF +
"capability:candidate:1.0")) {
candidateCapability = true;
} else if (uri.equals(URN_IETF_PARAMS_XML_NS_NETCONF +
"capability:confirmed-commit:1.0")) {
confirmedCommitCapability = true;
} else if (uri.equals(URN_IETF_PARAMS_XML_NS_NETCONF +
"capability:validate:1.0")) {
validateCapability = true;
} else if (uri.equals(URN_IETF_PARAMS_XML_NS_NETCONF +
"capability:url:1.0")) {
urlCapability = true;
if (parts[1] != null) {
urlSchemes = parts[1].split(",");
}
}
// tail-f proprietary capas
else if (uri.equals(WITH_DEFAULTS_CAPABILITY)) {
withDefaultsCapability = true;
} else if (uri.equals(ACTIONS_CAPABILITY)) {
actionsCapability = true;
} else if (uri.equals(TRANSACTIONS_CAPABILITY)) {
transactionsCapability = true;
} else {
// It's either a proper data schema capability or some
// homegrown agent capability
data_capas.add(new Capa(uri, rev));
}
}
}
/** Checks all capabilities including the rfc 4711 ones */
public boolean hasCapability(String uri) {
for (final Capa c : capas) {
if (c.uri.equals(uri)) {
return true;
}
}
return false;
}
/**
* Returns the revision for a specific uri, return null if no revision
* found. Only check the user data capabilities.
*/
public String getRevision(String uri) {
for (Capa capa : data_capas) {
if (capa.uri.equals(uri)) {
return capa.revision;
}
}
return null;
}
}