JSCAPE MFT Server

com.jscape.inet.mft.management.descriptors
Class HttpConfiguration

java.lang.Object
  extended by com.jscape.inet.mft.management.descriptors.HttpConfiguration
All Implemented Interfaces:
Configuration

public class HttpConfiguration
extends java.lang.Object
implements Configuration

HTTP service descriptor.


Field Summary
static int DEFAULT_TIMEOUT
          Default connection timeout of 600,000 ms.
static java.lang.String LOGO_PIC
           
 
Constructor Summary
HttpConfiguration()
          Creates new instance.
HttpConfiguration(HttpConfiguration that)
          Creates new instance from existing instance.
HttpConfiguration(TaggedProperties[] languages, java.lang.String logo, AutoLogoutTimeout autoLogoutTimeout, long connectionTimeout, java.lang.String redirectionUrl, boolean showButtonsShortcuts, boolean showTransferType, boolean showLoginInfo, boolean showAccountLink, boolean showSearch, boolean documentViewerEnabled, boolean emailFileTransferEnabled, Form[] uploadForms, SelfRegistrationConfiguration registrationConfiguration, java.lang.String aftpNatHost)
          Creates new instance.
 
Method Summary
 void adjustLanguages(TaggedProperties original)
          Resets language resources to provided defaults.
 java.lang.String getAftpNatHost()
          Returns AFTP NAT host for Java applet connection.
 AutoLogoutTimeout getAutoLogoutTimeout()
          Gets automatic inactivity logout descriptor.
 long getConnectionTimeout()
          Gets HTTP connection timeout in ms.
 boolean getDocumentViewerEnabled()
          Gets whether Web Document Viewer enabled.
 boolean getEmailFileTransferEnabled()
          Gets whether ad-hoc email file transfer enabled.
 TaggedProperties[] getLanguages()
          Gets language resources.
 java.lang.String getLogo()
          Gets logo.
 java.lang.String getRedirectionUrl()
          Returns logout redirection URL.
 SelfRegistrationConfiguration getRegistrationConfiguration()
          Gets self-registration process configuration.
 boolean getShowAccountLink()
          Gets whether account link is shown in web interface.
 boolean getShowButtonsShortcuts()
          Gets whether button shortcuts are enabled.
 boolean getShowLoginInfo()
          Gets whether login information is shown in web interface.
 boolean getShowSearch()
          Gets whether search form is shown in web interface.
 boolean getShowTransferType()
          Gets whether transfer type is shown in web interface.
 Form[] getUploadForms()
          Returns upload forms.
 boolean getUseFlashUploadComponent()
          Deprecated. Support for Flash upload removed
 byte[] logoBytes()
          Gets raw logo image data.
 void logoBytes(byte[] data)
          Sets the logo.
 void setAftpNatHost(java.lang.String value)
          Sets AFTP NAT host for Java applet connection.
 void setAutoLogoutTimeout(AutoLogoutTimeout value)
          Sets automatic inactivity logout descriptor.
 void setConnectionTimeout(long value)
          Sets HTTP connection timeout in ms.
 void setDocumentViewerEnabled(boolean value)
          Sets whether Web Document Viewer enabled.
 void setEmailFileTransferEnabled(boolean value)
          Sets whether ad-hoc email file transfer enabled.
 void setLanguages(TaggedProperties[] value)
          Sets language resources.
 void setLogo(java.lang.String value)
          Sets logo data.
 void setRedirectionUrl(java.lang.String value)
          Sets logout redirection URL.
 void setRegistrationConfiguration(SelfRegistrationConfiguration value)
          Sets self-registration process configuration.
 void setShowAccountLink(boolean value)
          Sets whether accoun link is shown in web interface.
 void setShowButtonsShortcuts(boolean value)
          Sets whether button shortcuts are enabled.
 void setShowLoginInfo(boolean value)
          Sets whether login information is shown in web interface.
 void setShowSearch(boolean value)
          Sets whether search form is shown in web interface.
 void setShowTransferType(boolean value)
          Sets whether transfer type is shown in web interface.
 void setUploadForms(Form[] value)
          Sets upload forms.
 void setUseFlashUploadComponent(boolean value)
          Deprecated. Support for Flash upload removed
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT
Default connection timeout of 600,000 ms.

See Also:
Constant Field Values

LOGO_PIC

public static final java.lang.String LOGO_PIC
See Also:
Constant Field Values
Constructor Detail

HttpConfiguration

public HttpConfiguration(TaggedProperties[] languages,
                         java.lang.String logo,
                         AutoLogoutTimeout autoLogoutTimeout,
                         long connectionTimeout,
                         java.lang.String redirectionUrl,
                         boolean showButtonsShortcuts,
                         boolean showTransferType,
                         boolean showLoginInfo,
                         boolean showAccountLink,
                         boolean showSearch,
                         boolean documentViewerEnabled,
                         boolean emailFileTransferEnabled,
                         Form[] uploadForms,
                         SelfRegistrationConfiguration registrationConfiguration,
                         java.lang.String aftpNatHost)
Creates new instance.

Parameters:
languages - language-related strings
logo - logo data
autoLogoutTimeout - auto logout timeout in ms
connectionTimeout - connection timeout in ms
redirectionUrl - redirection URL
showButtonsShortcuts - show buttons shortcuts flag
showTransferType - show transfer type flag
showLoginInfo - show login info flag
showAccountLink - show account link flag
showSearch - show search form flag
documentViewerEnabled - document viewer flag
emailFileTransferEnabled - ad-hoc email file transfer flag
uploadForms - upload forms
registrationConfiguration - self-registration configuration
aftpNatHost - AFTP NAT host for Java applet connection if any

HttpConfiguration

public HttpConfiguration(HttpConfiguration that)
Creates new instance from existing instance.

Parameters:
that - existing instance

HttpConfiguration

public HttpConfiguration()
Creates new instance.

Method Detail

getLanguages

public TaggedProperties[] getLanguages()
Gets language resources.

Returns:
language-related resources

setLanguages

public void setLanguages(TaggedProperties[] value)
Sets language resources.

Parameters:
value - language-related resources

getLogo

public java.lang.String getLogo()
Gets logo.

Returns:
logo data

setLogo

public void setLogo(java.lang.String value)
Sets logo data.

Parameters:
value - sets logo data as Base64-encoded string

logoBytes

public byte[] logoBytes()
Gets raw logo image data.

Returns:
logo data as byte array

logoBytes

public void logoBytes(byte[] data)
Sets the logo.

Parameters:
data - the logo data bytes

getAutoLogoutTimeout

public AutoLogoutTimeout getAutoLogoutTimeout()
Gets automatic inactivity logout descriptor.

Returns:
AutoLogoutTimeout descriptor

setAutoLogoutTimeout

public void setAutoLogoutTimeout(AutoLogoutTimeout value)
Sets automatic inactivity logout descriptor.

Parameters:
value - AutoLogoutTimeout descriptor

getShowButtonsShortcuts

public boolean getShowButtonsShortcuts()
Gets whether button shortcuts are enabled.

Returns:
true if enabled, false otherwise

setShowButtonsShortcuts

public void setShowButtonsShortcuts(boolean value)
Sets whether button shortcuts are enabled.

Parameters:
value - true if enabled, false otherwise

getRedirectionUrl

public java.lang.String getRedirectionUrl()
Returns logout redirection URL.

Returns:
logout redirection URL

setRedirectionUrl

public void setRedirectionUrl(java.lang.String value)
Sets logout redirection URL.

Parameters:
value - logout redirection URL

getShowLoginInfo

public boolean getShowLoginInfo()
Gets whether login information is shown in web interface.

Returns:
true if enabled, false otherwise

setShowLoginInfo

public void setShowLoginInfo(boolean value)
Sets whether login information is shown in web interface.

Parameters:
value - true if enabled, false otherwise

getShowAccountLink

public boolean getShowAccountLink()
Gets whether account link is shown in web interface.

Returns:
true if enabled, false otherwise

setShowAccountLink

public void setShowAccountLink(boolean value)
Sets whether accoun link is shown in web interface.

Parameters:
value - true if enabled, false otherwise

getConnectionTimeout

public long getConnectionTimeout()
Gets HTTP connection timeout in ms.

Returns:
timeout in ms

setConnectionTimeout

public void setConnectionTimeout(long value)
Sets HTTP connection timeout in ms.

Parameters:
value - timeout in ms

getShowTransferType

public boolean getShowTransferType()
Gets whether transfer type is shown in web interface.

Returns:
true if enabled, false otherwise

setShowTransferType

public void setShowTransferType(boolean value)
Sets whether transfer type is shown in web interface.

Parameters:
value - true if enabled, false otherwise

getDocumentViewerEnabled

public boolean getDocumentViewerEnabled()
Gets whether Web Document Viewer enabled.

Returns:
true if enabled, false otherwise

setDocumentViewerEnabled

public void setDocumentViewerEnabled(boolean value)
Sets whether Web Document Viewer enabled.

Parameters:
value - true if enabled, false otherwise

getUseFlashUploadComponent

public boolean getUseFlashUploadComponent()
Deprecated. Support for Flash upload removed

Gets whether Flash Upload Component will be used.

Returns:
false

setUseFlashUploadComponent

public void setUseFlashUploadComponent(boolean value)
Deprecated. Support for Flash upload removed

Gets whether Flash Upload Component is used.

Parameters:
value - true if used, false otherwise

getEmailFileTransferEnabled

public boolean getEmailFileTransferEnabled()
Gets whether ad-hoc email file transfer enabled.

Returns:
true if enabled; false otherwise

setEmailFileTransferEnabled

public void setEmailFileTransferEnabled(boolean value)
Sets whether ad-hoc email file transfer enabled.

Parameters:
value - true if enabled; false otherwise

getUploadForms

public Form[] getUploadForms()
Returns upload forms.

Returns:
upload forms

setUploadForms

public void setUploadForms(Form[] value)
Sets upload forms.

Parameters:
value - upload forms

getShowSearch

public boolean getShowSearch()
Gets whether search form is shown in web interface.

Returns:
true is shown; false otherwise.

setShowSearch

public void setShowSearch(boolean value)
Sets whether search form is shown in web interface.

Parameters:
value - true if is shown; false otherwise

getRegistrationConfiguration

public SelfRegistrationConfiguration getRegistrationConfiguration()
Gets self-registration process configuration.

Returns:
self-registration configuration

setRegistrationConfiguration

public void setRegistrationConfiguration(SelfRegistrationConfiguration value)
Sets self-registration process configuration.

Parameters:
value - self-registration configuration

getAftpNatHost

public java.lang.String getAftpNatHost()
Returns AFTP NAT host for Java applet connection.

Returns:
the NAT host

setAftpNatHost

public void setAftpNatHost(java.lang.String value)
Sets AFTP NAT host for Java applet connection.

Parameters:
value - the NAT host

adjustLanguages

public void adjustLanguages(TaggedProperties original)
Resets language resources to provided defaults.

Parameters:
original - the default language resources

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

JSCAPE MFT Server

Copyright © JSCAPE LLC. 1999-2013. All Rights Reserved