|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xmatters.integrations.ws.AlarmPointWebServiceClient
public class AlarmPointWebServiceClient
Used to interact with the AlarmPoint Web Services using straight XML Documents
Field Summary | |
---|---|
static java.lang.String |
AP_NAMESPACE
|
static java.lang.String |
AP_NAMESPACE_PREFIX
|
static java.lang.String |
OK_STATUS
|
static java.lang.String |
SOAP_NAMESPACE
|
static java.lang.String |
SOAP_NAMESPACE_PREFIX
|
Constructor Summary | |
---|---|
AlarmPointWebServiceClient(java.lang.String url,
java.lang.String username,
java.lang.String password,
java.lang.String company)
Create a new web service client using the specified request parameters |
|
AlarmPointWebServiceClient(java.lang.String url,
java.lang.String username,
java.lang.String password,
java.lang.String clientIP,
java.lang.String clientOSUser,
java.lang.String company)
Create a new web service client using the specified request parameters |
Method Summary | |
---|---|
org.dom4j.Element |
createElement(java.lang.String name,
java.lang.String value)
Create a XML Element with the specified name and value using the default AlarmPoint namespace |
org.dom4j.Element |
createElement(java.lang.String name,
java.lang.String value,
org.dom4j.Namespace namespace)
Create a XML Element with the specified name and value using the specified namespace |
java.lang.String |
getClientIP()
|
java.lang.String |
getClientOSUser()
|
java.lang.String |
getCompany()
|
java.lang.String |
getPassword()
|
java.lang.String |
getUrl()
|
java.lang.String |
getUsername()
|
org.dom4j.Node |
send(java.lang.String action,
org.dom4j.Element... elements)
Make a web service request to the AlarmPoint server and return the response |
java.lang.String |
sendCheckStatus(java.lang.String action,
org.dom4j.Element... elements)
Make a web service request to the AlarmPoint server and only return the return status |
org.dom4j.Node |
sendReceive(java.lang.String action,
org.dom4j.Element payload)
Send a SOAP request to the ServiceCenter server and return the contents to the returned SOAP body |
void |
setClientIP(java.lang.String clientIP)
|
void |
setClientOSUser(java.lang.String clientOSUser)
|
void |
setCompany(java.lang.String company)
|
void |
setPassword(java.lang.String password)
|
void |
setUrl(java.lang.String url)
|
void |
setUsername(java.lang.String username)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SOAP_NAMESPACE_PREFIX
public static final java.lang.String SOAP_NAMESPACE
public static final java.lang.String AP_NAMESPACE_PREFIX
public static final java.lang.String AP_NAMESPACE
public static final java.lang.String OK_STATUS
Constructor Detail |
---|
public AlarmPointWebServiceClient(java.lang.String url, java.lang.String username, java.lang.String password, java.lang.String company)
url
- Url of the AlarmPoint web serverusername
- User name to use for all web service requestspassword
- Password to use for all web service requestscompany
- Company to use for all web service requestspublic AlarmPointWebServiceClient(java.lang.String url, java.lang.String username, java.lang.String password, java.lang.String clientIP, java.lang.String clientOSUser, java.lang.String company)
url
- Url of the AlarmPoint web serverusername
- User name to use for all web service requestspassword
- Password to use for all web service requestsclientIP
- Client ip address to use for web service request loggingclientOSUser
- Client os user to use for web service request loggingcompany
- Company to use for all web service requestsMethod Detail |
---|
public java.lang.String sendCheckStatus(java.lang.String action, org.dom4j.Element... elements)
action
- The web service Action to use ('AddUser' for example)elements
- All the elements in order to add to the request (for an AddUser request you would need the ap:person element for example)
public org.dom4j.Node send(java.lang.String action, org.dom4j.Element... elements)
action
- The web service Action to use ('AddUser' for example)elements
- All the elements in order to add to the request (for an AddUser request you would need the ap:person element for example)
public org.dom4j.Node sendReceive(java.lang.String action, org.dom4j.Element payload)
action
- The SOAP Action to perform in ServiceCenter. The possible values are defined on the extaccess tablepayload
- A dom4j Element that will be the payload of the SOAP request
public org.dom4j.Element createElement(java.lang.String name, java.lang.String value)
name
- Element namevalue
- Element value. If null no value will be added.
public org.dom4j.Element createElement(java.lang.String name, java.lang.String value, org.dom4j.Namespace namespace)
name
- Element namevalue
- Element value. If null no value will be added.namespace
- The namespace to use for the new Element
public java.lang.String getUrl()
public void setUrl(java.lang.String url)
public java.lang.String getUsername()
public void setUsername(java.lang.String username)
public java.lang.String getPassword()
public void setPassword(java.lang.String password)
public java.lang.String getClientIP()
public void setClientIP(java.lang.String clientIP)
public java.lang.String getClientOSUser()
public void setClientOSUser(java.lang.String clientOSUser)
public java.lang.String getCompany()
public void setCompany(java.lang.String company)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |