com.cryptshare.api

Class Policy

java.lang.Object

com.cryptshare.api.Policy

public class Policy
extends java.lang.Object

The combined set of policy settings that has been determined by the server.

Constructor Summary

Constructors

Constructor and Description

Policy(boolean showFilenames, boolean showFilenamesChangeable, boolean showZipContent, boolean downloadNotification, boolean downloadNotificationChangeable, boolean allowConfidentialMessage, boolean forceConfidentialMessage, boolean allowCustomRecipientMessage, int storageDuration, int transferLimit, java.util.Set<PasswordMode> allowedStandardPasswordModes, java.util.Set<PasswordMode> allowedQuickPasswordModes, QuickMode quickMode, boolean quickModeChangeable, java.util.Set<java.lang.String> failedEmailAddresses) Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Set<PasswordMode>	getAllowedQuickPasswordModes() Returns the allowed password modes for a QUICK transfer.
java.util.Set<PasswordMode>	getAllowedStandardPasswordModes() Returns the allowed password modes for a standard (password based) transfer.
java.util.Set<java.lang.String>	getFailedEmailAddresses() Gets the set of failed recipient addresses that are not allowed by this policy.
QuickMode	getQuickMode() Returns the default value for QUICK - whether it is disabled, enabled or enabled if all connections are established.
int	getStorageDuration() Returns the maximum allowed storage duration for a transfer, in days.
int	getTransferLimit() Returns the maximum size of a transfer, in MB.
boolean	isAllowConfidentialMessage() Returns whether it's allowed to send the message as confidential message.
boolean	isAllowCustomRecipientMessage() Returns whether it's allowed to customize the message for the recipients.
boolean	isDownloadNotification() Returns whether the sender will be notified about downloads.
boolean	isDownloadNotificationChangeable() Returns whether it's allowed to modify the default setting for isDownloadNotification().
boolean	isForceConfidentialMessage() Returns whether it's enforced that the message is sent as confidential message.
boolean	isQuickModeChangeable() Returns whether it's allowed to modify the default setting for getQuickMode().
boolean	isShowFilenames() Returns whether file names are displayed in the recipient notification by default.
boolean	isShowFilenamesChangeable() Returns whether it's allowed to modify the default setting for isShowFilenames().
boolean	isShowZipContent() Returns whether contents of ZIP files are displayed in the recipient notification by default.

Methods inherited from class java.lang.Object

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

Constructor Detail

Policy

public Policy(boolean showFilenames,
              boolean showFilenamesChangeable,
              boolean showZipContent,
              boolean downloadNotification,
              boolean downloadNotificationChangeable,
              boolean allowConfidentialMessage,
              boolean forceConfidentialMessage,
              boolean allowCustomRecipientMessage,
              int storageDuration,
              int transferLimit,
              java.util.Set<PasswordMode> allowedStandardPasswordModes,
              java.util.Set<PasswordMode> allowedQuickPasswordModes,
              QuickMode quickMode,
              boolean quickModeChangeable,
              java.util.Set<java.lang.String> failedEmailAddresses)

Constructor.

Parameters:

showFilenames - Whether file names are displayed in the recipient notification by default.

showFilenamesChangeable - Whether it's allowed to modify the default setting of isShowFilenames().

showZipContent - Whether contents of ZIP files are displayed in the recipient notification by default.

downloadNotification - Whether the sender will be notified about downloads.

downloadNotificationChangeable - Whether it's allowed to modify the default setting of isDownloadNotification().

allowConfidentialMessage - Whether it's allowed to send the message as confidential messages.

forceConfidentialMessage - Whether it's enforced that the message is sent as confidential messages.

allowCustomRecipientMessage - Whether it's allowed to customize the message for the recipients.

storageDuration - The maximum allowed storage duration for a transfer, in days.

transferLimit - The maximum size of a transfer, in MB. The sum of all files in a transfer cannot exceed the policy's transfer limit.

allowedStandardPasswordModes - The allowed password modes for a standard (password based) transfer.

allowedQuickPasswordModes - The allowed password modes for a QUICK transfer.

quickMode - The default value for QUICK - whether it is disabled, enabled or enabled if all connections are established.

quickModeChangeable - Whether it's allowed to modify the default setting for #getQuickMode().

failedEmailAddresses - The list of failed recipient addresses that are not allowed by this policy.

Method Detail

isShowFilenames

public boolean isShowFilenames()

Returns whether file names are displayed in the recipient notification by default.

Returns:

true, if file names are displayed, false otherwise.

isShowFilenamesChangeable

public boolean isShowFilenamesChangeable()

Returns whether it's allowed to modify the default setting for isShowFilenames().

Returns:

true, if the setting is changeable, false otherwise.

isShowZipContent

public boolean isShowZipContent()

Returns whether contents of ZIP files are displayed in the recipient notification by default.

Returns:

true, if the contents of ZIP files are displayed, false otherwise.

isDownloadNotification

public boolean isDownloadNotification()

Returns whether the sender will be notified about downloads.

Returns:

true, if the sender will be notified, false otherwise.

isDownloadNotificationChangeable

public boolean isDownloadNotificationChangeable()

Returns whether it's allowed to modify the default setting for isDownloadNotification().

Returns:

true, if the setting is changeable, false otherwise.

isAllowConfidentialMessage

public boolean isAllowConfidentialMessage()

Returns whether it's allowed to send the message as confidential message.

Returns:

true, if it's allowed to send the message as confidential message, false otherwise.

isForceConfidentialMessage

public boolean isForceConfidentialMessage()

Returns whether it's enforced that the message is sent as confidential message.

Returns:

true, if it's enforced, false otherwise.

isAllowCustomRecipientMessage

public boolean isAllowCustomRecipientMessage()

Returns whether it's allowed to customize the message for the recipients.

Returns:

true, if customization is allowed, false otherwise.

getStorageDuration

public int getStorageDuration()

Returns the maximum allowed storage duration for a transfer, in days.

Returns:

The allowed storage duration for a transfer, in days.

getTransferLimit

public int getTransferLimit()

Returns the maximum size of a transfer, in MB. The sum of all files in a transfer cannot exceed the policy's transfer limit.

Returns:

The maximum size of a transfer, in MB.

getAllowedStandardPasswordModes

public java.util.Set<PasswordMode> getAllowedStandardPasswordModes()

Returns the allowed password modes for a standard (password based) transfer. The set is never null.

Returns:

A Set of all allowed password modes for a standard (password based) transfer, never null.

getAllowedQuickPasswordModes

public java.util.Set<PasswordMode> getAllowedQuickPasswordModes()

Returns the allowed password modes for a QUICK transfer. The set is never null.

Returns:

A Set of all allowed password modes for a QUICK, never null.

getQuickMode

public QuickMode getQuickMode()

Returns the default value for QUICK - whether it is disabled, enabled or enabled if all connections are established.

Returns:

The QuickMode determining the default QUICK state.

isQuickModeChangeable

public boolean isQuickModeChangeable()

Returns whether it's allowed to modify the default setting for getQuickMode().

Returns:

true, if the setting is changeable, false otherwise.

getFailedEmailAddresses

public java.util.Set<java.lang.String> getFailedEmailAddresses()

Gets the set of failed recipient addresses that are not allowed by this policy. The set is never null.

Returns:

A Set of Strings with all recipient email addresses that are not allowed by this policy, never null.