com.citrix.sharefile.api.entities

Class SFZonesEntity

java.lang.Object

com.citrix.sharefile.api.entities.SFEntitiesBase

com.citrix.sharefile.api.entities.SFZonesEntity

public class SFZonesEntity
extends SFEntitiesBase

Field Summary

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

client

Constructor Summary

Constructors

Constructor and Description
SFZonesEntity(ISFApiClient client)

Method Summary

Methods

Modifier and Type	Method and Description
ISFQuery<SFZone>	create(SFZone zone) Create Zone { "Name":"Name", "HeartbeatTolerance":10, "ZoneServices":"StorageZone, SharepointConnector, NetworkShareConnector" } Creates a new Zone.
ISFQuery<SFODataFeed<SFMetadata>>	createMetadata(java.net.URI url, java.util.ArrayList<SFMetadata> metadata) Create or update Zone Metadata [ {"Name":"metadataName1", "Value":"metadataValue1", "IsPublic":"true"}, {"Name":"metadataName2", "Value":"metadataValue2", "IsPublic":"false"}, ...
ISFQuery<SFAccount>	createTenants(java.net.URI parentUrl, java.lang.String accountId) Add a tenant account to a multi-tenant zone
ISFQuery	delete(java.net.URI url)
ISFQuery	delete(java.net.URI url, java.lang.Boolean force)
ISFQuery	delete(java.net.URI url, java.lang.Boolean force, java.lang.String newDefaultZoneId)
ISFQuery	deleteMetadata(java.net.URI url, java.lang.String name) Delete Zone Metadata Delete the Metadata entry associated with the specified zone
ISFQuery	deleteTenants(java.net.URI parentUrl, java.lang.String id, java.lang.String newDefaultZoneId) Remove a tenant from a multi-tenant zone
ISFQuery	deleteTenants(java.net.URI parentUrl, java.lang.String id, java.lang.String newDefaultZoneId, java.lang.Boolean expireItems) Remove a tenant from a multi-tenant zone
ISFQuery<SFODataFeed<SFZone>>	get() Get List of Zones Retrieve the list of Zones accessible to the authenticated user This method will concatenate the list of private zones in the user's account and the list of public zones accessible to this account.
ISFQuery<SFODataFeed<SFZone>>	get(SFSafeEnumFlags<SFZoneService> services) Get List of Zones Retrieve the list of Zones accessible to the authenticated user This method will concatenate the list of private zones in the user's account and the list of public zones accessible to this account.
ISFQuery<SFODataFeed<SFZone>>	get(SFSafeEnumFlags<SFZoneService> services, java.lang.Boolean includeDisabled) Get List of Zones Retrieve the list of Zones accessible to the authenticated user This method will concatenate the list of private zones in the user's account and the list of public zones accessible to this account.
ISFQuery<SFZone>	get(java.net.URI url) Get List of Zones Retrieve the list of Zones accessible to the authenticated user This method will concatenate the list of private zones in the user's account and the list of public zones accessible to this account.
ISFQuery<SFZone>	get(java.net.URI url, java.lang.Boolean secret) Get List of Zones Retrieve the list of Zones accessible to the authenticated user This method will concatenate the list of private zones in the user's account and the list of public zones accessible to this account.
ISFQuery<SFODataFeed<SFMetadata>>	getMetadata(java.net.URI url) Get Zone Metadata Gets metadata associated with the specified zone
ISFQuery<SFODataFeed<SFAccount>>	getTenants(java.net.URI parentUrl) Get the tenants of a multi-tenant zone
ISFQuery<SFZone>	resetSecret(java.net.URI url) Reset Zone Secret Resets the current Zone Secret to a new Random value Caution! This Call will invalidate all Storage Center communications until the Storage Center Zone secret is also updated.
ISFQuery<SFZone>	update(java.net.URI url, SFZone zone) Update Zone { "Name":"Name", "HeartbeatTolerance":10, "ZoneServices":"StorageZone, SharepointConnector, NetworkShareConnector" } Updates an existing zone

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

SFZonesEntity

public SFZonesEntity(ISFApiClient client)

Method Detail

get

public ISFQuery<SFODataFeed<SFZone>> get(SFSafeEnumFlags<SFZoneService> services,
                                java.lang.Boolean includeDisabled)
                                  throws InvalidOrMissingParameterException

Get List of Zones Retrieve the list of Zones accessible to the authenticated user This method will concatenate the list of private zones in the user's account and the list of public zones accessible to this account. Any user can see the list of zones.

Parameters:

services - (default: StorageZone)

includeDisabled - (default: false)

Returns:

The list of public and private zones accessible to this user

Throws:

InvalidOrMissingParameterException

get

public ISFQuery<SFODataFeed<SFZone>> get(SFSafeEnumFlags<SFZoneService> services)
                                  throws InvalidOrMissingParameterException

Get List of Zones Retrieve the list of Zones accessible to the authenticated user This method will concatenate the list of private zones in the user's account and the list of public zones accessible to this account. Any user can see the list of zones.

Parameters:

services - (default: StorageZone)

Returns:

The list of public and private zones accessible to this user

Throws:

InvalidOrMissingParameterException

get

public ISFQuery<SFODataFeed<SFZone>> get()

Get List of Zones Retrieve the list of Zones accessible to the authenticated user This method will concatenate the list of private zones in the user's account and the list of public zones accessible to this account. Any user can see the list of zones.

Returns:

The list of public and private zones accessible to this user

get

public ISFQuery<SFZone> get(java.net.URI url,
                   java.lang.Boolean secret)
                     throws InvalidOrMissingParameterException

Get List of Zones Retrieve the list of Zones accessible to the authenticated user This method will concatenate the list of private zones in the user's account and the list of public zones accessible to this account. Any user can see the list of zones.

Returns:

The list of public and private zones accessible to this user

Throws:

InvalidOrMissingParameterException

get

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

Get List of Zones Retrieve the list of Zones accessible to the authenticated user This method will concatenate the list of private zones in the user's account and the list of public zones accessible to this account. Any user can see the list of zones.

Returns:

The list of public and private zones accessible to this user

Throws:

InvalidOrMissingParameterException

create

public ISFQuery<SFZone> create(SFZone zone)
                        throws InvalidOrMissingParameterException

Create Zone { "Name":"Name", "HeartbeatTolerance":10, "ZoneServices":"StorageZone, SharepointConnector, NetworkShareConnector" } Creates a new Zone.

Returns:

the created zone

Throws:

InvalidOrMissingParameterException

update

public ISFQuery<SFZone> update(java.net.URI url,
                      SFZone zone)
                        throws InvalidOrMissingParameterException

Update Zone { "Name":"Name", "HeartbeatTolerance":10, "ZoneServices":"StorageZone, SharepointConnector, NetworkShareConnector" } Updates an existing zone

Parameters:

url -

zone -

Returns:

The modified zone

Throws:

InvalidOrMissingParameterException

delete

public ISFQuery delete(java.net.URI url,
              java.lang.Boolean force,
              java.lang.String newDefaultZoneId)
                throws InvalidOrMissingParameterException

Throws:

InvalidOrMissingParameterException

delete

public ISFQuery delete(java.net.URI url,
              java.lang.Boolean force)
                throws InvalidOrMissingParameterException

Throws:

InvalidOrMissingParameterException

delete

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

Throws:

InvalidOrMissingParameterException

resetSecret

public ISFQuery<SFZone> resetSecret(java.net.URI url)
                             throws InvalidOrMissingParameterException

Reset Zone Secret Resets the current Zone Secret to a new Random value Caution! This Call will invalidate all Storage Center communications until the Storage Center Zone secret is also updated. User must be a Zone admin to perform this action

Parameters:

url -

Returns:

The modified Zone object

Throws:

InvalidOrMissingParameterException

getTenants

public ISFQuery<SFODataFeed<SFAccount>> getTenants(java.net.URI parentUrl)
                                            throws InvalidOrMissingParameterException

Get the tenants of a multi-tenant zone

Parameters:

parentUrl -

Returns:

List of tenant accounts, not including the zone admin account.

Throws:

InvalidOrMissingParameterException

createTenants

public ISFQuery<SFAccount> createTenants(java.net.URI parentUrl,
                                java.lang.String accountId)
                                  throws InvalidOrMissingParameterException

Add a tenant account to a multi-tenant zone

Parameters:

parentUrl -

accountId -

Throws:

InvalidOrMissingParameterException

deleteTenants

public ISFQuery deleteTenants(java.net.URI parentUrl,
                     java.lang.String id,
                     java.lang.String newDefaultZoneId,
                     java.lang.Boolean expireItems)
                       throws InvalidOrMissingParameterException

Remove a tenant from a multi-tenant zone

Parameters:

parentUrl -

id -

newDefaultZoneId -

expireItems - (default: false)

Throws:

InvalidOrMissingParameterException

deleteTenants

public ISFQuery deleteTenants(java.net.URI parentUrl,
                     java.lang.String id,
                     java.lang.String newDefaultZoneId)
                       throws InvalidOrMissingParameterException

Remove a tenant from a multi-tenant zone

Parameters:

parentUrl -

id -

newDefaultZoneId -

Throws:

InvalidOrMissingParameterException

getMetadata

public ISFQuery<SFODataFeed<SFMetadata>> getMetadata(java.net.URI url)
                                              throws InvalidOrMissingParameterException

Get Zone Metadata Gets metadata associated with the specified zone

Parameters:

url -

Returns:

the zone metadata feed

Throws:

InvalidOrMissingParameterException

createMetadata

public ISFQuery<SFODataFeed<SFMetadata>> createMetadata(java.net.URI url,
                                               java.util.ArrayList<SFMetadata> metadata)
                                                 throws InvalidOrMissingParameterException

Create or update Zone Metadata [ {"Name":"metadataName1", "Value":"metadataValue1", "IsPublic":"true"}, {"Name":"metadataName2", "Value":"metadataValue2", "IsPublic":"false"}, ... ] Creates or updates Metadata entries associated with the specified zone

Parameters:

url -

metadata -

Returns:

the zone metadata feed

Throws:

InvalidOrMissingParameterException

deleteMetadata

public ISFQuery deleteMetadata(java.net.URI url,
                      java.lang.String name)
                        throws InvalidOrMissingParameterException

Delete Zone Metadata Delete the Metadata entry associated with the specified zone

Parameters:

url -

name -

Returns:

no data on success

Throws:

InvalidOrMissingParameterException