Package org.netxms.client.datacollection
Class WebServiceDefinition
java.lang.Object
org.netxms.client.datacollection.WebServiceDefinition
Web service definition
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final int
- 
Constructor SummaryConstructorsConstructorDescriptionWebServiceDefinition(String name) Create new definition.Create definition from NXCP message
- 
Method SummaryModifier and TypeMethodDescriptionvoidfillMessage(NXCPMessage msg) Fill NXCP message with object dataintintgetFlags()Get flags.getGuid()Get value of given header.String[]Get all header names.Get headers.Get HTTP request method.intgetId()Get web service definition ID.getLogin()getName()intgetUrl()booleanGet "follow location" flag.booleanbooleanbooleanvoidremoveHeader(String name) Remove header.voidsetAuthenticationType(WebServiceAuthType authenticationType) voidsetCacheRetentionTime(int cacheRetentionTime) voidsetDescription(String description) voidsetFlags(int flags) Set flags.voidsetFollowLocation(boolean followLocation) set "follow location" flag.voidvoidSet header value.voidsetHttpRequestMethod(HttpRequestMethod httpRequestMethod) Set HTTP request method.voidsetId(int id) Set web service definition ID.voidvoidvoidsetParseAsText(boolean useTextParsing) Sets if text parsing should be usedvoidsetPassword(String password) voidsetRequestData(String requestData) voidsetRequestTimeout(int requestTimeout) voidvoidsetVerifyCertificate(boolean verifyCertificate) voidsetVerifyHost(boolean verifyHost) 
- 
Field Details- 
VERIFY_CERTIFICATEpublic static final int VERIFY_CERTIFICATE- See Also:
 
- 
VERIFY_HOSTpublic static final int VERIFY_HOST- See Also:
 
- 
PARSE_AS_TEXTpublic static final int PARSE_AS_TEXT- See Also:
 
- 
FOLLOW_LOCATIONpublic static final int FOLLOW_LOCATION- See Also:
 
 
- 
- 
Constructor Details- 
WebServiceDefinitionCreate new definition. Definition object will be created with random GUID and ID 0.- Parameters:
- name- name for new definition
 
- 
WebServiceDefinitionCreate definition from NXCP message- Parameters:
- msg- NXCP message
 
 
- 
- 
Method Details- 
fillMessageFill NXCP message with object data- Parameters:
- msg- NXCP message
 
- 
getHeadersGet headers. Collection returned is actual header set and any changes to it will affect web service definition object.- Returns:
- defined headers
 
- 
getHeaderNamesGet all header names. Returned array is a copy of actual header set.- Returns:
- array containing all header names
 
- 
getHeaderGet value of given header.- Parameters:
- name- header name
- Returns:
- header value or null
 
- 
setHeaderSet header value.- Parameters:
- name- header name
- value- new header value
 
- 
removeHeaderRemove header.- Parameters:
- name- header name
 
- 
getIdpublic int getId()Get web service definition ID.- Returns:
- web service definition ID
 
- 
setIdpublic void setId(int id) Set web service definition ID.- Parameters:
- id- new web service definition ID
 
- 
getGuid- Returns:
- the guid
 
- 
setGuid- Parameters:
- guid- the guid to set
 
- 
getName- Returns:
- the name
 
- 
setName- Parameters:
- name- the name to set
 
- 
getDescription- Returns:
- the description
 
- 
setDescription- Parameters:
- description- the description to set
 
- 
getUrl- Returns:
- the url
 
- 
setUrl- Parameters:
- url- the url to set
 
- 
getHttpRequestMethodGet HTTP request method.- Returns:
- HTTP request method
 
- 
setHttpRequestMethodSet HTTP request method.- Parameters:
- httpRequestMethod- HTTP request method
 
- 
getRequestData- Returns:
- the requestData
 
- 
setRequestData- Parameters:
- requestData- the requestData to set
 
- 
getAuthenticationType- Returns:
- the authenticationType
 
- 
setAuthenticationType- Parameters:
- authenticationType- the authenticationType to set
 
- 
getLogin- Returns:
- the login
 
- 
setLogin- Parameters:
- login- the login to set
 
- 
getPassword- Returns:
- the password
 
- 
setPassword- Parameters:
- password- the password to set
 
- 
getCacheRetentionTimepublic int getCacheRetentionTime()- Returns:
- the cacheRetentionTime
 
- 
setCacheRetentionTimepublic void setCacheRetentionTime(int cacheRetentionTime) - Parameters:
- cacheRetentionTime- the cacheRetentionTime to set
 
- 
getRequestTimeoutpublic int getRequestTimeout()- Returns:
- the requestTimeout
 
- 
setRequestTimeoutpublic void setRequestTimeout(int requestTimeout) - Parameters:
- requestTimeout- the requestTimeout to set
 
- 
getFlagspublic int getFlags()Get flags.- Returns:
- flags
 
- 
setFlagspublic void setFlags(int flags) Set flags.- Parameters:
- flags- new flags
 
- 
isVerifyCertificatepublic boolean isVerifyCertificate()- Returns:
- the verifyCertificate
 
- 
setVerifyCertificatepublic void setVerifyCertificate(boolean verifyCertificate) - Parameters:
- verifyCertificate- the verifyCertificate to set
 
- 
isVerifyHostpublic boolean isVerifyHost()- Returns:
- the verify host
 
- 
setVerifyHostpublic void setVerifyHost(boolean verifyHost) - Parameters:
- verifyHost- the verifyHost to set
 
- 
isFollowLocationpublic boolean isFollowLocation()Get "follow location" flag.- Returns:
- "follow location" flag
 
- 
setFollowLocationpublic void setFollowLocation(boolean followLocation) set "follow location" flag.- Parameters:
- followLocation- new value for "follow location" flag
 
- 
setParseAsTextpublic void setParseAsText(boolean useTextParsing) Sets if text parsing should be used- Parameters:
- useTextParsing- if text parsing should be used
 
- 
isTextParsingUsedpublic boolean isTextParsingUsed()- Returns:
- if text parsing should be used
 
 
-