Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemSIPAddACLEntryRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>

co.ecg.alpaca.toolkit.generated.BWSystem.SystemSIPAddACLEntryRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemSIPAddACLEntryRequest
extends Request<DefaultResponse>

Add an entry to the SIP access control list. The response is either SuccessResponse or ErrorResponse.

Author:

AlpacaGenerator

Nested Class Summary

Nested classes/interfaces inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

Request.Protocol

Field Summary

Fields

Modifier and Type	Field	Description
protected @Size(min=1,max=80) String	description
protected @NotNull @Size(min=1,max=39) String	netAddress
protected @NotNull SIPACLTransportProtocol	transportProtocol

Fields inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

log

Constructor Summary

Constructors

Constructor	Description
SystemSIPAddACLEntryRequest()
SystemSIPAddACLEntryRequest(BroadWorksServer broadWorksServer, String netAddress, SIPACLTransportProtocol transportProtocol)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getDescription()
static BWSystem.SystemSIPAddACLEntryRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getNetAddress()
SIPACLTransportProtocol	getTransportProtocol()
BWSystem.SystemSIPAddACLEntryRequest	setDescription(String description)
BWSystem.SystemSIPAddACLEntryRequest	setNetAddress(String netAddress)
BWSystem.SystemSIPAddACLEntryRequest	setTransportProtocol(SIPACLTransportProtocol transportProtocol)

Methods inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createNilElement, createTextElement, equals, fire, fire, getBroadWorksServer, getCacheString, getCommandElement, getCommandType, getDomDocument, getId, getOCSProtocol, getRequestTimeoutMillis, getResponseClass, getRetries, getRetryCodes, getRootElement, getValidationErrorsAsString, hashCode, isIgnoreCache, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, setIgnoreCache, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, setResponseClass, setRetries, setRetryCodes, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

netAddress

@NotNull
@Size(min=1,
      max=39)
protected @NotNull @Size(min=1,max=39) String netAddress

transportProtocol

@NotNull
protected @NotNull SIPACLTransportProtocol transportProtocol

description

@Size(min=1,
      max=80)
protected @Size(min=1,max=80) String description

Constructor Details

SystemSIPAddACLEntryRequest

public SystemSIPAddACLEntryRequest()

SystemSIPAddACLEntryRequest

public SystemSIPAddACLEntryRequest(BroadWorksServer broadWorksServer,
 String netAddress,
 SIPACLTransportProtocol transportProtocol)

Method Details

setNetAddress

public BWSystem.SystemSIPAddACLEntryRequest setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

setTransportProtocol

public BWSystem.SystemSIPAddACLEntryRequest setTransportProtocol(SIPACLTransportProtocol transportProtocol)

getTransportProtocol

public SIPACLTransportProtocol getTransportProtocol()

setDescription

public BWSystem.SystemSIPAddACLEntryRequest setDescription(String description)

getDescription

public String getDescription()

getEmptyObject

public static BWSystem.SystemSIPAddACLEntryRequest getEmptyObject(BroadWorksServer broadWorksServer)

Retrieves this object with minimal setup.

Parameters:

broadWorksServer - The BroadWorksServer

formRequest

public void formRequest()

Forms the XML Document for this Request Object. Called by the Request upon fire().

Overrides:

formRequest in class Request<DefaultResponse>