com.citrix.sharefile.api.entities

Class SFConnectorGroupsEntity

java.lang.Object

com.citrix.sharefile.api.entities.SFEntitiesBase

com.citrix.sharefile.api.entities.SFConnectorGroupsEntity

public class SFConnectorGroupsEntity
extends SFEntitiesBase

Field Summary

Fields inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

client

Constructor Summary

Constructors

Constructor and Description
SFConnectorGroupsEntity(ISFApiClient client)

Method Summary

Methods

Modifier and Type	Method and Description
ISFQuery<SFConnectorGroup>	byProvider(java.lang.String provider) Get the Connector Group by Provider
ISFQuery<SFConnectorGroup>	create(SFConnectorGroup connectorGroup) Create a Connector Group associated with a Zone { "Zones":[ "Zone": {"Id":"ZoneId"}, "StorageCenter": [ { "Id":"StorageCenterId" }, { ...
ISFQuery<SFConnectorGroupAccessControl>	createAccessControls(java.net.URI url, SFConnectorGroupAccessControl connectorGroupAcl) Adds a new principal to the Connector Group Access Control List { "Principal": {"Id":"PrincipalId"}, "CanCreate":"true", "CanManage":"true" }
ISFQuery<SFODataFeed<SFStorageCenter>>	createStorageCenters(java.net.URI url, java.lang.String zoneid, SFStorageCenter storageCenter) Adds a Connector Group to a Storage Center { "Id":"storageCenterId" } Associate a Connector Group with a Storage Center.
ISFQuery<SFConnectorGroupZone>	createZones(java.net.URI url, SFConnectorGroupZone connectorGroupZone) Associates a Zone to an existing Connecto Group { "Zone": {"Id":"ZoneId"}, "StorageCenter": [ { "Id":"StorageCenterId" }, { ...
ISFQuery	delete(java.net.URI url) Removes a Connector Group Removes a Connector Group and all associations from Zones
ISFQuery	deleteAccessControls(java.net.URI serviceUrl, java.lang.String zoneid) Removes a Connector Group Access Control object Removes an Access Control object from the Connector Group ACL.
ISFQuery	deleteZones(java.net.URI serviceUrl, java.lang.String zoneid) Removes a Connector Group association with a Zone Removes a Connector Group association with a Zone.
ISFQuery<SFODataFeed<SFConnectorGroup>>	get()
ISFQuery<SFConnectorGroup>	get(java.net.URI url) Get all Connector Groups in the account Retrieves a Connector Group
ISFQuery<SFConnectorGroupAccessControl>	getAccessControls(java.net.URI parentUrl, java.lang.String id) Get an Access Control element Retrieves a Connector Group Access Control of a given user
ISFQuery<SFODataFeed<SFConnectorGroup>>	getByZone(java.lang.String zoneid) Get Connector Groups in a Zone Retrieves the Connector Groups defined in a Zone.
ISFQuery<SFODataFeed<SFStorageCenter>>	getStorageCenters(java.net.URI url, java.lang.String zoneid) Retrieve the list of Storage Centers associated with a Connector Group Retrieve the list of storage centers associated with a Connector Group.
ISFQuery<SFConnectorGroupZone>	getZones(java.net.URI url, java.lang.String id) Get the Connector Group by Service ID Retrieves a Connector Group
ISFQuery<SFConnectorGroupZone>	updateZones(java.net.URI url, java.lang.String zoneId, SFConnectorGroupZone connectorGroupZone) Modifies the parameters of a Connector Group in associated with a Zone { "Zone": {"Id":"ZoneId"}, "ApiVersionMin":"v3", "ApiVersionMax":"v3", "IconUrl":"https://domain/icons", "FormUrl":"https://domain/forms" }

Methods inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

getEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

SFConnectorGroupsEntity

public SFConnectorGroupsEntity(ISFApiClient client)

Method Detail

get

public ISFQuery<SFODataFeed<SFConnectorGroup>> get()

get

public ISFQuery<SFConnectorGroup> get(java.net.URI url)
                               throws InvalidOrMissingParameterException

Get all Connector Groups in the account Retrieves a Connector Group

Returns:

A single ConnectorGroup object matching the query

Throws:

InvalidOrMissingParameterException

byProvider

public ISFQuery<SFConnectorGroup> byProvider(java.lang.String provider)
                                      throws InvalidOrMissingParameterException

Get the Connector Group by Provider

Parameters:

provider -

Returns:

A single ConnectorGroup matching the query

Throws:

InvalidOrMissingParameterException

getZones

public ISFQuery<SFConnectorGroupZone> getZones(java.net.URI url,
                                      java.lang.String id)
                                        throws InvalidOrMissingParameterException

Get the Connector Group by Service ID Retrieves a Connector Group

Parameters:

id -

Returns:

A single ConnectorGroup object matching the query

Throws:

InvalidOrMissingParameterException

getAccessControls

public ISFQuery<SFConnectorGroupAccessControl> getAccessControls(java.net.URI parentUrl,
                                                        java.lang.String id)
                                                          throws InvalidOrMissingParameterException

Get an Access Control element Retrieves a Connector Group Access Control of a given user

Parameters:

parentUrl -

id -

Returns:

A single ConnectorGroup ACL object matching the query

Throws:

InvalidOrMissingParameterException

getByZone

public ISFQuery<SFODataFeed<SFConnectorGroup>> getByZone(java.lang.String zoneid)
                                                  throws InvalidOrMissingParameterException

Get Connector Groups in a Zone Retrieves the Connector Groups defined in a Zone.

Returns:

Access Control List of the given object ID.

Throws:

InvalidOrMissingParameterException

create

public ISFQuery<SFConnectorGroup> create(SFConnectorGroup connectorGroup)
                                  throws InvalidOrMissingParameterException

Create a Connector Group associated with a Zone { "Zones":[ "Zone": {"Id":"ZoneId"}, "StorageCenter": [ { "Id":"StorageCenterId" }, { ... } ], "ApiVersionMin":"v3", "ApiVersionMax":"v3", "IconUrl":"https://domain/icons", "FormUrl":"https://domain/forms" ], "Id":"ServiceId", "Name":""Name, "Provider":"svc" } Creates a new Connector Group, or adds a Zone to an existing Connector Group if the Group is already associated with another Zone. The caller doesn't have to check if the group exists or not - just call this API passing the Service ID and the associated Zone information.

Parameters:

connectorGroup -

Returns:

the created or modified AccessControl instance

Throws:

InvalidOrMissingParameterException

createZones

public ISFQuery<SFConnectorGroupZone> createZones(java.net.URI url,
                                         SFConnectorGroupZone connectorGroupZone)
                                           throws InvalidOrMissingParameterException

Associates a Zone to an existing Connecto Group { "Zone": {"Id":"ZoneId"}, "StorageCenter": [ { "Id":"StorageCenterId" }, { ... } ], "ApiVersionMin":"v3", "ApiVersionMax":"v3", "IconUrl":"https://domain/icons", "FormUrl":"https://domain/forms" } Adds a Zone to an existing Connector Group.

Parameters:

url -

connectorGroupZone -

Returns:

the created or modified AccessControl instance

Throws:

InvalidOrMissingParameterException

createAccessControls

public ISFQuery<SFConnectorGroupAccessControl> createAccessControls(java.net.URI url,
                                                           SFConnectorGroupAccessControl connectorGroupAcl)
                                                             throws InvalidOrMissingParameterException

Adds a new principal to the Connector Group Access Control List { "Principal": {"Id":"PrincipalId"}, "CanCreate":"true", "CanManage":"true" }

Parameters:

url -

connectorGroupAcl -

Returns:

The created access control list object

Throws:

InvalidOrMissingParameterException

updateZones

public ISFQuery<SFConnectorGroupZone> updateZones(java.net.URI url,
                                         java.lang.String zoneId,
                                         SFConnectorGroupZone connectorGroupZone)
                                           throws InvalidOrMissingParameterException

Modifies the parameters of a Connector Group in associated with a Zone { "Zone": {"Id":"ZoneId"}, "ApiVersionMin":"v3", "ApiVersionMax":"v3", "IconUrl":"https://domain/icons", "FormUrl":"https://domain/forms" }

Parameters:

url -

connectorGroupZone -

Returns:

the created or modified AccessControl instance

Throws:

InvalidOrMissingParameterException

delete

public ISFQuery delete(java.net.URI url)
                throws InvalidOrMissingParameterException

Removes a Connector Group Removes a Connector Group and all associations from Zones

Parameters:

url -

Throws:

InvalidOrMissingParameterException

deleteZones

public ISFQuery deleteZones(java.net.URI serviceUrl,
                   java.lang.String zoneid)
                     throws InvalidOrMissingParameterException

Removes a Connector Group association with a Zone Removes a Connector Group association with a Zone. Connector Groups are automatically removed once the groups is removed from all the Zones.

Parameters:

serviceUrl -

Throws:

InvalidOrMissingParameterException

deleteAccessControls

public ISFQuery deleteAccessControls(java.net.URI serviceUrl,
                            java.lang.String zoneid)
                              throws InvalidOrMissingParameterException

Removes a Connector Group Access Control object Removes an Access Control object from the Connector Group ACL. This removes the permissions of the affected principal to use the Connector Group.

Parameters:

serviceUrl -

Throws:

InvalidOrMissingParameterException

getStorageCenters

public ISFQuery<SFODataFeed<SFStorageCenter>> getStorageCenters(java.net.URI url,
                                                       java.lang.String zoneid)
                                                         throws InvalidOrMissingParameterException

Retrieve the list of Storage Centers associated with a Connector Group Retrieve the list of storage centers associated with a Connector Group.

Parameters:

url -

Returns:

The modified Connector Group

Throws:

InvalidOrMissingParameterException

createStorageCenters

public ISFQuery<SFODataFeed<SFStorageCenter>> createStorageCenters(java.net.URI url,
                                                          java.lang.String zoneid,
                                                          SFStorageCenter storageCenter)
                                                            throws InvalidOrMissingParameterException

Adds a Connector Group to a Storage Center { "Id":"storageCenterId" } Associate a Connector Group with a Storage Center. The Connector Group has to be associated with the Storage Center Zone.

Parameters:

url -

Returns:

The modified Connector Group

Throws:

InvalidOrMissingParameterException