public final class Capabilities extends Object
The usage and content of the capabilities are by the WITSML standard completely optional. Users of JWitsml are however encouraged to specify their client capabilities properly.
Client capabilities are established when the WitsmlServer instance is created:
// Identify ourself and our capabilities as WITSML client Capabilities clientCapabilities = new Capabilities(WitsmlVersion.VERSION_1_3_1, "First And Lastname", "e-mail@some.org", "+12 34 56 789", "Description", "Application Name", "Vendor", "Version Number"); // Establish URL to the server URL url = new URL("http://path/to/witsml/server"); // Create the WITSML server instance WitsmlServer witsmlServer = new WitsmlServer(url, "userName", "password", clientCapabilities);
The server capabilities are available from the WitsmlServer instance:
// Get server capabilities Capabilities serverCapabilities = witsmlServer.getServerCapabilities();This class is immutable.
Constructor and Description |
---|
Capabilities(WitsmlVersion version,
String contactName,
String contactEmail,
String contactPhone,
String name,
String description,
String vendor,
String programVersion)
Create a client capabilities object with the specified properties.
|
Modifier and Type | Method and Description |
---|---|
Boolean |
getCascadedDelete()
Get whether the server supports cascaded deletion.
|
String |
getCompressionMethod()
Get supported compression methods for client requests.
|
String |
getContactEmail()
Return contact e-mail for the site.
|
String |
getContactName()
Get contact name for the site.
|
String |
getContactPhone()
Get contact phone for the site.
|
String |
getDescription()
Get description of the application program.
|
Collection<FunctionCapability> |
getFunctions()
Return all supported functions and which objects they support.
|
Integer |
getMaxRequestLatestValues()
Get maximum number of values per (log) curve that the server returns when the
latest values are requested.
|
String |
getName()
Return name of the application program.
|
String |
getProgramVersion()
Get application program version.
|
Boolean |
getSupportUomConversion()
Get whether or not the server supports unit of measure conversion.
|
String |
getVendor()
Get application program vendor.
|
String |
getWitsmlVersion()
Return WITSML version(s) supported.
|
boolean |
isServer()
Check if this is a server (true) or a client (false) capabilities
object.
|
String |
toString()
Return a string representation of this instance.
|
public Capabilities(WitsmlVersion version, String contactName, String contactEmail, String contactPhone, String name, String description, String vendor, String programVersion)
version
- WITSML version accepted by client. May be null.contactName
- Contact name. May be null.contactEmail
- Contact e-mail. May be null.contactPhone
- Contact phone number. May be null.name
- System product name. May be null.description
- System description. May be null.vendor
- System vendor. May be null.programVersion
- System version. May be null.public boolean isServer()
public String getWitsmlVersion()
The client capabilities instance will return the string representation of the argument passed to the constructor, or null if none was provided.
public String getContactName()
public String getContactEmail()
public String getContactPhone()
public String getName()
public String getDescription()
public String getVendor()
public String getProgramVersion()
public String getCompressionMethod()
public Integer getMaxRequestLatestValues()
public Boolean getCascadedDelete()
public Boolean getSupportUomConversion()
public Collection<FunctionCapability> getFunctions()
Copyright © 2023 Petroware AS - https://petroware.no