Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemFileRepositoryDeviceAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemFileRepositoryDeviceAddRequest

Enclosing class:

BWSystem

@ChoiceGroup("protocolWebDAV") @ChoiceGroup("protocolFTP") @ChoiceGroup("protocolSFTP") @ChoiceGroup("protocolFTPS")
public static class BWSystem.SystemFileRepositoryDeviceAddRequest
extends Request<DefaultResponse>

Add a new file repository. 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 @NotNull @Size(min=1,max=40) String	name
protected Integer	port
protected @Valid FileRepositoryProtocolFTP16	protocolFTP
protected @Valid FileRepositoryProtocolFTP16	protocolFTPS
protected @Valid FileRepositoryProtocolFTP16	protocolSFTP
protected @Valid FileRepositoryProtocolWebDAV20	protocolWebDAV
protected @Size(min=1,max=256) String	rootDirectory

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

log

Constructor Summary

Constructors

Constructor	Description
SystemFileRepositoryDeviceAddRequest()
SystemFileRepositoryDeviceAddRequest(BroadWorksServer broadWorksServer, FileRepositoryProtocolFTP16 protocolFTP, String name)
SystemFileRepositoryDeviceAddRequest(BroadWorksServer broadWorksServer, FileRepositoryProtocolWebDAV20 protocolWebDAV, String name)
SystemFileRepositoryDeviceAddRequest(BroadWorksServer broadWorksServer, String name)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static BWSystem.SystemFileRepositoryDeviceAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getName()
Integer	getPort()
FileRepositoryProtocolFTP16	getProtocolFTP()
FileRepositoryProtocolFTP16	getProtocolFTPS()
FileRepositoryProtocolFTP16	getProtocolSFTP()
FileRepositoryProtocolWebDAV20	getProtocolWebDAV()
String	getRootDirectory()
BWSystem.SystemFileRepositoryDeviceAddRequest	setName(String name)
BWSystem.SystemFileRepositoryDeviceAddRequest	setPort(Integer port)
BWSystem.SystemFileRepositoryDeviceAddRequest	setProtocolFTP(FileRepositoryProtocolFTP16 protocolFTP)
BWSystem.SystemFileRepositoryDeviceAddRequest	setProtocolFTPS(FileRepositoryProtocolFTP16 protocolFTPS)
BWSystem.SystemFileRepositoryDeviceAddRequest	setProtocolSFTP(FileRepositoryProtocolFTP16 protocolSFTP)
BWSystem.SystemFileRepositoryDeviceAddRequest	setProtocolWebDAV(FileRepositoryProtocolWebDAV20 protocolWebDAV)
BWSystem.SystemFileRepositoryDeviceAddRequest	setRootDirectory(String rootDirectory)

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

name

@NotNull
@Size(min=1,
      max=40)
protected @NotNull @Size(min=1,max=40) String name

rootDirectory

@Size(min=1,
      max=256)
protected @Size(min=1,max=256) String rootDirectory

port

protected Integer port

protocolWebDAV

@Valid
protected @Valid FileRepositoryProtocolWebDAV20 protocolWebDAV

protocolFTP

@Valid
protected @Valid FileRepositoryProtocolFTP16 protocolFTP

protocolSFTP

@Valid
protected @Valid FileRepositoryProtocolFTP16 protocolSFTP

protocolFTPS

@Valid
protected @Valid FileRepositoryProtocolFTP16 protocolFTPS

Constructor Details

SystemFileRepositoryDeviceAddRequest

public SystemFileRepositoryDeviceAddRequest()

SystemFileRepositoryDeviceAddRequest

public SystemFileRepositoryDeviceAddRequest(BroadWorksServer broadWorksServer,
 String name)

SystemFileRepositoryDeviceAddRequest

public SystemFileRepositoryDeviceAddRequest(BroadWorksServer broadWorksServer,
 FileRepositoryProtocolWebDAV20 protocolWebDAV,
 String name)

SystemFileRepositoryDeviceAddRequest

public SystemFileRepositoryDeviceAddRequest(BroadWorksServer broadWorksServer,
 FileRepositoryProtocolFTP16 protocolFTP,
 String name)

Method Details

setName

public BWSystem.SystemFileRepositoryDeviceAddRequest setName(String name)

getName

public String getName()

setRootDirectory

public BWSystem.SystemFileRepositoryDeviceAddRequest setRootDirectory(String rootDirectory)

getRootDirectory

public String getRootDirectory()

setPort

public BWSystem.SystemFileRepositoryDeviceAddRequest setPort(Integer port)

getPort

public Integer getPort()

setProtocolWebDAV

public BWSystem.SystemFileRepositoryDeviceAddRequest setProtocolWebDAV(FileRepositoryProtocolWebDAV20 protocolWebDAV)

getProtocolWebDAV

public FileRepositoryProtocolWebDAV20 getProtocolWebDAV()

setProtocolFTP

public BWSystem.SystemFileRepositoryDeviceAddRequest setProtocolFTP(FileRepositoryProtocolFTP16 protocolFTP)

getProtocolFTP

public FileRepositoryProtocolFTP16 getProtocolFTP()

setProtocolSFTP

public BWSystem.SystemFileRepositoryDeviceAddRequest setProtocolSFTP(FileRepositoryProtocolFTP16 protocolSFTP)

getProtocolSFTP

public FileRepositoryProtocolFTP16 getProtocolSFTP()

setProtocolFTPS

public BWSystem.SystemFileRepositoryDeviceAddRequest setProtocolFTPS(FileRepositoryProtocolFTP16 protocolFTPS)

getProtocolFTPS

public FileRepositoryProtocolFTP16 getProtocolFTPS()

getEmptyObject

public static BWSystem.SystemFileRepositoryDeviceAddRequest 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>