co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemSIPDeviceTypeFileAddRequest20

java.lang.Object

co.ecg.alpaca.toolkit.Request<Response.DefaultResponse>

co.ecg.alpaca.toolkit.generated.BWSystem.SystemSIPDeviceTypeFileAddRequest20

All Implemented Interfaces:

Runnable

Enclosing class:

BWSystem

public static class BWSystem.SystemSIPDeviceTypeFileAddRequest20
extends Request<Response.DefaultResponse>

Request to add a sip device type file. The response is either SuccessResponse or ErrorResponse.

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	allowHttp
boolean	allowHttpIsModified
Boolean	allowHttps
boolean	allowHttpsIsModified
Boolean	allowTftp
boolean	allowTftpIsModified
Boolean	allowUploadFromDevice
boolean	allowUploadFromDeviceIsModified
Boolean	defaultExtendedFileCaptureMode
boolean	defaultExtendedFileCaptureModeIsModified
String	deviceType
boolean	deviceTypeIsModified
Boolean	enableCaching
boolean	enableCachingIsModified
DeviceManagementFileCategory	fileCategory
boolean	fileCategoryIsModified
DeviceManagementFileCustomization	fileCustomization
boolean	fileCustomizationIsModified
String	fileFormat
boolean	fileFormatIsModified
DeviceTypeFileEnhancedConfigurationMode	fileSource
boolean	fileSourceIsModified
Boolean	macBasedFileAuthentication
boolean	macBasedFileAuthenticationIsModified
String	macFormatInNonRequestURI
boolean	macFormatInNonRequestURIIsModified
Boolean	macInNonRequestURI
boolean	macInNonRequestURIIsModified
String	remoteFileFormat
boolean	remoteFileFormatIsModified
FileResource	uploadFile
boolean	uploadFileIsModified
Boolean	useHttpDigestAuthentication
boolean	useHttpDigestAuthenticationIsModified
Boolean	userNamePasswordFileAuthentication
boolean	userNamePasswordFileAuthenticationIsModified

Constructor Summary

Constructors

Constructor and Description
SystemSIPDeviceTypeFileAddRequest20(BroadWorksServer bws) Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()
SystemSIPDeviceTypeFileAddRequest20(BroadWorksServer bws, String deviceType, String fileFormat, String remoteFileFormat, DeviceManagementFileCategory fileCategory, DeviceManagementFileCustomization fileCustomization, DeviceTypeFileEnhancedConfigurationMode fileSource, Boolean useHttpDigestAuthentication, Boolean macBasedFileAuthentication, Boolean userNamePasswordFileAuthentication, Boolean macInNonRequestURI, Boolean allowHttp, Boolean allowHttps, Boolean allowTftp, Boolean enableCaching, Boolean allowUploadFromDevice)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
Boolean	getAllowHttp()
Boolean	getAllowHttps()
Boolean	getAllowTftp()
Boolean	getAllowUploadFromDevice()
Boolean	getDefaultExtendedFileCaptureMode()
String	getDeviceType()
Boolean	getEnableCaching()
DeviceManagementFileCategory	getFileCategory()
DeviceManagementFileCustomization	getFileCustomization()
String	getFileFormat()
DeviceTypeFileEnhancedConfigurationMode	getFileSource()
Boolean	getMacBasedFileAuthentication()
String	getMacFormatInNonRequestURI()
Boolean	getMacInNonRequestURI()
String	getRemoteFileFormat()
FileResource	getUploadFile()
Boolean	getUseHttpDigestAuthentication()
Boolean	getUserNamePasswordFileAuthentication()
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setAllowHttp(Boolean allowHttp)
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setAllowHttps(Boolean allowHttps)
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setAllowTftp(Boolean allowTftp)
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setAllowUploadFromDevice(Boolean allowUploadFromDevice)
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setDefaultExtendedFileCaptureMode(Boolean defaultExtendedFileCaptureMode)
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setDeviceType(String deviceType)
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setEnableCaching(Boolean enableCaching)
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setFileCategory(DeviceManagementFileCategory fileCategory)
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setFileCustomization(DeviceManagementFileCustomization fileCustomization)
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setFileFormat(String fileFormat)
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setFileSource(DeviceTypeFileEnhancedConfigurationMode fileSource)
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setMacBasedFileAuthentication(Boolean macBasedFileAuthentication)
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setMacFormatInNonRequestURI(String macFormatInNonRequestURI)
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setMacInNonRequestURI(Boolean macInNonRequestURI)
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setRemoteFileFormat(String remoteFileFormat)
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setUploadFile(FileResource uploadFile)
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setUseHttpDigestAuthentication(Boolean useHttpDigestAuthentication)
BWSystem.SystemSIPDeviceTypeFileAddRequest20	setUserNamePasswordFileAuthentication(Boolean userNamePasswordFileAuthentication)

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

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandType, getDomDocument, getResponseClass, isMemberOfBundle, isValid, run, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setMemberOfBundle, setRequestId, setResponseClass, setRootElement, toString, validate

Methods inherited from class java.lang.Object

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

Field Detail

deviceType

@Size(min=1,
      max=40)
public String deviceType

deviceTypeIsModified

public transient boolean deviceTypeIsModified

fileFormat

@Size(min=1,
      max=128)
public String fileFormat

fileFormatIsModified

public transient boolean fileFormatIsModified

remoteFileFormat

@Size(min=1,
      max=128)
public String remoteFileFormat

remoteFileFormatIsModified

public transient boolean remoteFileFormatIsModified

fileCategory

public DeviceManagementFileCategory fileCategory

fileCategoryIsModified

public transient boolean fileCategoryIsModified

fileCustomization

public DeviceManagementFileCustomization fileCustomization

fileCustomizationIsModified

public transient boolean fileCustomizationIsModified

fileSource

public DeviceTypeFileEnhancedConfigurationMode fileSource

fileSourceIsModified

public transient boolean fileSourceIsModified

uploadFile

public FileResource uploadFile

uploadFileIsModified

public transient boolean uploadFileIsModified

useHttpDigestAuthentication

public Boolean useHttpDigestAuthentication

useHttpDigestAuthenticationIsModified

public transient boolean useHttpDigestAuthenticationIsModified

macBasedFileAuthentication

public Boolean macBasedFileAuthentication

macBasedFileAuthenticationIsModified

public transient boolean macBasedFileAuthenticationIsModified

userNamePasswordFileAuthentication

public Boolean userNamePasswordFileAuthentication

userNamePasswordFileAuthenticationIsModified

public transient boolean userNamePasswordFileAuthenticationIsModified

macInNonRequestURI

public Boolean macInNonRequestURI

macInNonRequestURIIsModified

public transient boolean macInNonRequestURIIsModified

macFormatInNonRequestURI

@Size(min=1,
      max=256)
public String macFormatInNonRequestURI

macFormatInNonRequestURIIsModified

public transient boolean macFormatInNonRequestURIIsModified

allowHttp

public Boolean allowHttp

allowHttpIsModified

public transient boolean allowHttpIsModified

allowHttps

public Boolean allowHttps

allowHttpsIsModified

public transient boolean allowHttpsIsModified

allowTftp

public Boolean allowTftp

allowTftpIsModified

public transient boolean allowTftpIsModified

enableCaching

public Boolean enableCaching

enableCachingIsModified

public transient boolean enableCachingIsModified

allowUploadFromDevice

public Boolean allowUploadFromDevice

allowUploadFromDeviceIsModified

public transient boolean allowUploadFromDeviceIsModified

defaultExtendedFileCaptureMode

public Boolean defaultExtendedFileCaptureMode

defaultExtendedFileCaptureModeIsModified

public transient boolean defaultExtendedFileCaptureModeIsModified

Constructor Detail

SystemSIPDeviceTypeFileAddRequest20

public SystemSIPDeviceTypeFileAddRequest20(BroadWorksServer bws,
                                           String deviceType,
                                           String fileFormat,
                                           String remoteFileFormat,
                                           DeviceManagementFileCategory fileCategory,
                                           DeviceManagementFileCustomization fileCustomization,
                                           DeviceTypeFileEnhancedConfigurationMode fileSource,
                                           Boolean useHttpDigestAuthentication,
                                           Boolean macBasedFileAuthentication,
                                           Boolean userNamePasswordFileAuthentication,
                                           Boolean macInNonRequestURI,
                                           Boolean allowHttp,
                                           Boolean allowHttps,
                                           Boolean allowTftp,
                                           Boolean enableCaching,
                                           Boolean allowUploadFromDevice)

SystemSIPDeviceTypeFileAddRequest20

public SystemSIPDeviceTypeFileAddRequest20(BroadWorksServer bws)

Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()

Parameters:

bws - The BroadWorksServer to use for the Request

Method Detail

setDeviceType

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setDeviceType(String deviceType)

getDeviceType

public String getDeviceType()

setFileFormat

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setFileFormat(String fileFormat)

getFileFormat

public String getFileFormat()

setRemoteFileFormat

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setRemoteFileFormat(String remoteFileFormat)

getRemoteFileFormat

public String getRemoteFileFormat()

setFileCategory

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setFileCategory(DeviceManagementFileCategory fileCategory)

getFileCategory

public DeviceManagementFileCategory getFileCategory()

setFileCustomization

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setFileCustomization(DeviceManagementFileCustomization fileCustomization)

getFileCustomization

public DeviceManagementFileCustomization getFileCustomization()

setFileSource

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setFileSource(DeviceTypeFileEnhancedConfigurationMode fileSource)

getFileSource

public DeviceTypeFileEnhancedConfigurationMode getFileSource()

setUploadFile

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setUploadFile(FileResource uploadFile)

getUploadFile

public FileResource getUploadFile()

setUseHttpDigestAuthentication

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setUseHttpDigestAuthentication(Boolean useHttpDigestAuthentication)

getUseHttpDigestAuthentication

public Boolean getUseHttpDigestAuthentication()

setMacBasedFileAuthentication

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setMacBasedFileAuthentication(Boolean macBasedFileAuthentication)

getMacBasedFileAuthentication

public Boolean getMacBasedFileAuthentication()

setUserNamePasswordFileAuthentication

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setUserNamePasswordFileAuthentication(Boolean userNamePasswordFileAuthentication)

getUserNamePasswordFileAuthentication

public Boolean getUserNamePasswordFileAuthentication()

setMacInNonRequestURI

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setMacInNonRequestURI(Boolean macInNonRequestURI)

getMacInNonRequestURI

public Boolean getMacInNonRequestURI()

setMacFormatInNonRequestURI

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setMacFormatInNonRequestURI(String macFormatInNonRequestURI)

getMacFormatInNonRequestURI

public String getMacFormatInNonRequestURI()

setAllowHttp

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setAllowHttp(Boolean allowHttp)

getAllowHttp

public Boolean getAllowHttp()

setAllowHttps

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setAllowHttps(Boolean allowHttps)

getAllowHttps

public Boolean getAllowHttps()

setAllowTftp

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setAllowTftp(Boolean allowTftp)

getAllowTftp

public Boolean getAllowTftp()

setEnableCaching

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setEnableCaching(Boolean enableCaching)

getEnableCaching

public Boolean getEnableCaching()

setAllowUploadFromDevice

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setAllowUploadFromDevice(Boolean allowUploadFromDevice)

getAllowUploadFromDevice

public Boolean getAllowUploadFromDevice()

setDefaultExtendedFileCaptureMode

public BWSystem.SystemSIPDeviceTypeFileAddRequest20 setDefaultExtendedFileCaptureMode(Boolean defaultExtendedFileCaptureMode)

getDefaultExtendedFileCaptureMode

public Boolean getDefaultExtendedFileCaptureMode()

formRequest

public void formRequest()
                 throws RequestException

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

Specified by:

formRequest in class Request<Response.DefaultResponse>

Throws:

RequestException