dm.soap.services.networkaddress

Class DmSoapNetworkAddress

java.lang.Object

DmSoapService

dm.soap.services.networkaddress.DmSoapNetworkAddress

Direct Known Subclasses:

DmSoapSamlNetworkAddress

@MTOM(enabled=true,
      threshold=2048)
public class DmSoapNetworkAddress
extends DmSoapService

This SOAP service is used to expose all Network Address related TechDoc operations.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.xml.ws.WebServiceContext	_context The WebServiceContext that called this service.

Constructor Summary

Constructors

Constructor and Description
DmSoapNetworkAddress()

Method Summary

Modifier and Type	Method and Description
int	createNetworkAddress(NetworkAddressInfo networkAddressInfo, java.lang.String reason) Web service operation for the CreateNetworkAddressCmd.
void	deleteNetworkAddress(java.lang.String IpAddress, java.lang.String reason) Web service operation for the DeleteNetworkAddressCmd.
boolean	exists(java.lang.String IpAddress) Web service operation to see if the specified network address exists.
void	modifyNetworkAddress(java.lang.String IpAddress, NetworkAddressInfo newNetworkAddressInfo, java.lang.String reason) Web service operation for the ModifyNetworkAddressCmd.
NetworkAddressInfo	showNetworkAddress(java.lang.String IpAddress) Web service operation for showing a specific network address specified by the IP address

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_context

protected javax.xml.ws.WebServiceContext _context

The WebServiceContext that called this service.

Constructor Detail

DmSoapNetworkAddress

public DmSoapNetworkAddress()

Method Detail

createNetworkAddress

public int createNetworkAddress(NetworkAddressInfo networkAddressInfo,
                                java.lang.String reason)
                         throws DmSoapException

Web service operation for the CreateNetworkAddressCmd.

Parameters:

networkAddressInfo - A NetworkAddressInfo object for the network address to create.

reason - The reason for executing this command, or null to use the default SOAP TechDoc reason.

Returns:

The ID of the network address created.

Throws:

DmSoapException - A DmSoapException if an error occurs.

deleteNetworkAddress

public void deleteNetworkAddress(java.lang.String IpAddress,
                                 java.lang.String reason)
                          throws DmSoapException

Web service operation for the DeleteNetworkAddressCmd.

Parameters:

IpAddress - The IP address.

reason - The reason for executing this command, or null to use the default SOAP TechDoc reason.

Throws:

DmSoapException - A DmSoapException if an error occurs.

exists

public boolean exists(java.lang.String IpAddress)
               throws DmSoapException

Web service operation to see if the specified network address exists.

Parameters:

IpAddress - The IpAddress of the NetworkAddress.

Throws:

DmSoapException - A DmSoapException if an error occurs.

modifyNetworkAddress

public void modifyNetworkAddress(java.lang.String IpAddress,
                                 NetworkAddressInfo newNetworkAddressInfo,
                                 java.lang.String reason)
                          throws DmSoapException

Web service operation for the ModifyNetworkAddressCmd. Obtain the NetworkAddressInfo object from showNetworkAddress for the network address you want to modify. Change what you want, and call modifyNetworkAddress with the IP Address and modified NetworkAddressInfo object.

Parameters:

IpAddress - The IP Address of the existing network address to modify.

newNetworkAddressInfo - A modified NetworkAddressInfo object for the network address specified.

reason - The reason for executing this command, or null to use the default SOAP TechDoc reason.

Throws:

DmSoapException - A DmSoapException if an error occurs.

showNetworkAddress

public NetworkAddressInfo showNetworkAddress(java.lang.String IpAddress)
                                      throws DmSoapException

Web service operation for showing a specific network address specified by the IP address

Parameters:

IpAddress - The IpAddress of the NetworkAddress.

Returns:

A NetworkAddressInfo object, or null.

Throws:

DmSoapException - A DmSoapException if an error occurs.