|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.vhosting.netconf.transport.Capability
public class Capability
This class represents a generic capability. When it is necessary to have a new capability, this class can be instantiated and used the instance to create new operations.
Nested Class Summary | |
---|---|
class |
Capability.CapabilityParams
This class defines the parameters for a capability provided by the server. |
Field Summary | |
---|---|
protected java.lang.String |
prefix
|
Constructor Summary | |
---|---|
Capability(java.lang.String capabilityBaseURI,
java.lang.String namespaceURI,
java.lang.String prefix)
Constructs the instance of a capability. |
Method Summary | |
---|---|
java.lang.String |
getCapabilityBaseURI()
Get the capability base Uri or the capability Uri without parameters. |
java.lang.String |
getNamespaceURI()
Get the capability namespace Uri. |
java.lang.String |
getPrefix()
Get the namespace prefix. |
Capability.CapabilityParams |
getServerCapabilityParams(Session session)
When the session is active, takes the server side parameters set for this capability. |
boolean |
isPresentOnServer(Session session)
Check if the capability is present on the server. |
java.lang.String |
toString()
|
void |
touch()
Use this method when you want to ensure that the capability is included in the Hello message before establishing a connection. |
void |
unsetServerCapabilityPresence(Session session)
Unset the presence of the capability on the server side. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.lang.String prefix
Constructor Detail |
---|
public Capability(java.lang.String capabilityBaseURI, java.lang.String namespaceURI, java.lang.String prefix)
capabilityBaseURI
- The capability base Uri or the capability Uri without
parameters.namespaceURI
- The namespace Uri for this capability.prefix
- The candidate namespace prefix of the namespace Uri.Method Detail |
---|
public java.lang.String toString()
toString
in class java.lang.Object
public final void touch()
public boolean isPresentOnServer(Session session)
session
- The active session.
public Capability.CapabilityParams getServerCapabilityParams(Session session)
session
- The active session.
public void unsetServerCapabilityPresence(Session session)
session
- The active session.public java.lang.String getPrefix()
public java.lang.String getNamespaceURI()
public java.lang.String getCapabilityBaseURI()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |