ILicense (Cleo VersaLex Java API)

All Superinterfaces:

java.rmi.Remote
```
public interface ILicense
extends java.rmi.Remote
```
Establishes an interface to VersaLex's License. Refer to ILexiCom.getLicense().
Methods provided allow for retrieval of installation's license information.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AS400` AS400 platform
`static int`	`ASDA` ASDA (Wal-Mart UK) host
`static int`	`EDS_ELIT` EDS*Elit host
`static int`	`GXS` GXS hosts
`static int`	`HARMONY` Cleo Harmony product
`static int`	`IBM_IE` IBM IE hosts
`static int`	`KOHLS` Kohl's host
`static int`	`LEXICOM` Cleo LexiCom product
`static int`	`MICHAELS` Michaels host
`static int`	`UNIX` Unix platform
`static int`	`VLTRADER` Cleo VLTrader product
`static int`	`WAL_MART` Wal-Mart host
`static int`	`WINDOWS` Windows platform

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`getActiveHostCount()` Get the number of active hosts
`int`	`getActiveHostLimit()` Get the license active host limit; <=0 indicates no limit
`long[]`	`getActiveMailboxCount()` Get the number of active mailboxes
`int`	`getActiveMailboxLimit()` Get the license active mailbox limit; <=0 indicates no limit
`long[]`	`getActiveProtocolCount(com.cleo.lexicom.beans.LicenseFields.Protocol protocol)` Get the number of active hosts or mailboxes for each protocol.
`int[]`	`getAllowedHosts()` Get the preconfigured hosts licensed
`java.lang.String`	`getHostID()` Get the host ID of the installation
`java.util.Date`	`getKeyExpiration()` Get the license key expiration date; null if permanent key
`int`	`getKeyHostID()` Get the host ID in the license
`java.lang.String`	`getOwner()` Get the license owner
`int`	`getPlatform()` Get the licensed platform(s)
`int`	`getProduct()` Get the licensed Cleo product
`long`	`getProtocolLimit(com.cleo.lexicom.beans.LicenseFields.Protocol protocol)` Get the mailbox limit for a protocol
`java.lang.String`	`getSerialNumber()` Get the license serial number
`java.util.Date`	`getSupportExpiration()` Get the support expiration date; null is no expiration set in license
`long`	`getTriggerPoolSize()` Get the trigger pool size (not applicable to LexiCom)
`boolean`	`isApiLicensed()` Indicates whether application program interface (API) is licensed
`boolean`	`isBackupOnly()` Indicates whether can only be a backup system
`boolean`	`isDashboards()` Indicates whether dashboards is licensed
`boolean`	`isFipsLicensed()` Indicates whether FIPS mode is licensed
`boolean`	`isIPFilter()` Indicates whether IP filtering is licensed
`boolean`	`isJavaScriptActions()` Indicates whether JavaScript actions are licensed (not applicable to LexiCom)
`boolean`	`isMailboxLimitPerHost()` Indicates whether the active mailbox limit is per host or overall
`boolean`	`isPerProtocol()` Indicates whether mailbox licensing is per protocol
`boolean`	`isSNMPAgent()` Indicates whether SNMP agent is licensed
`boolean`	`isSubscription()` Indicates whether the license is a subscription license or not
`boolean`	`isSystemMonitor()` Indicates whether system monitor is licensed
`boolean`	`isTemporary()` Indicates whether the license is temporary or permanent
`boolean`	`isTranslatorLicensed()` Indicates whether translator integration is licensed
`boolean`	`isTrustLicensed()` Indicates whether trust is licensed
`boolean`	`isUnifyLicensed()` Indicates whether unify is licensed
`boolean`	`isVLProxyLicensed()` Indicates whether VLProxy usage is licensed
`boolean`	`isWebBrowserLicensed()` Indicates whether web browser interface is licensed

- Field Detail
  - LEXICOM
```
static final int LEXICOM
```
    Cleo LexiCom product
    
    See Also:
    
    Constant Field Values
  - VLTRADER
```
static final int VLTRADER
```
    Cleo VLTrader product
    
    See Also:
    
    Constant Field Values
  - HARMONY
```
static final int HARMONY
```
    Cleo Harmony product
    
    See Also:
    
    Constant Field Values
  - WINDOWS
```
static final int WINDOWS
```
    Windows platform
    
    See Also:
    
    Constant Field Values
  - UNIX
```
static final int UNIX
```
    Unix platform
    
    See Also:
    
    Constant Field Values
  - AS400
```
static final int AS400
```
    AS400 platform
    
    See Also:
    
    Constant Field Values
  - MICHAELS
```
static final int MICHAELS
```
    Michaels host
    
    See Also:
    
    Constant Field Values
  - IBM_IE
```
static final int IBM_IE
```
    IBM IE hosts
    
    See Also:
    
    Constant Field Values
  - GXS
```
static final int GXS
```
    GXS hosts
    
    See Also:
    
    Constant Field Values
  - WAL_MART
```
static final int WAL_MART
```
    Wal-Mart host
    
    See Also:
    
    Constant Field Values
  - KOHLS
```
static final int KOHLS
```
    Kohl's host
    
    See Also:
    
    Constant Field Values
  - EDS_ELIT
```
static final int EDS_ELIT
```
    EDS*Elit host
    
    See Also:
    
    Constant Field Values
  - ASDA
```
static final int ASDA
```
    ASDA (Wal-Mart UK) host
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getProduct
```
int getProduct()
        throws java.rmi.RemoteException
```
    Get the licensed Cleo product
    
    Returns:
    
    the licensed Cleo product (LEXICOM or VLTRADER or HARMONY)
    
    Throws:
    
    java.rmi.RemoteException
  - getPlatform
```
int getPlatform()
         throws java.rmi.RemoteException
```
    Get the licensed platform(s)
    
    Returns:
    
    the licensed platform bitmap (WINDOWS &| UNIX &| AS400)
    
    Throws:
    
    java.rmi.RemoteException
  - getSerialNumber
```
java.lang.String getSerialNumber()
                          throws java.rmi.RemoteException
```
    Get the license serial number
    
    Returns:
    
    the serial number
    
    Throws:
    
    java.rmi.RemoteException
  - getOwner
```
java.lang.String getOwner()
                   throws java.rmi.RemoteException
```
    Get the license owner
    
    Returns:
    
    the owner
    
    Throws:
    
    java.rmi.RemoteException
  - getHostID
```
java.lang.String getHostID()
                    throws java.rmi.RemoteException
```
    Get the host ID of the installation
    
    Returns:
    
    the host ID
    
    Throws:
    
    java.rmi.RemoteException
  - getKeyHostID
```
int getKeyHostID()
          throws java.rmi.RemoteException
```
    Get the host ID in the license
    
    Returns:
    
    the host ID
    
    Throws:
    
    java.rmi.RemoteException
  - isTemporary
```
boolean isTemporary()
             throws java.rmi.RemoteException
```
    Indicates whether the license is temporary or permanent
    
    Returns:
    
    true if key has an expiration date
    
    Throws:
    
    java.rmi.RemoteException
  - isSubscription
```
boolean isSubscription()
                throws java.rmi.RemoteException
```
    Indicates whether the license is a subscription license or not
    
    Returns:
    
    true if the key is for a subscription license
    
    Throws:
    
    java.rmi.RemoteException
  - getKeyExpiration
```
java.util.Date getKeyExpiration()
                         throws java.rmi.RemoteException
```
    Get the license key expiration date; null if permanent key
    
    Returns:
    
    the key expiration date
    
    Throws:
    
    java.rmi.RemoteException
  - getAllowedHosts
```
int[] getAllowedHosts()
               throws java.rmi.RemoteException
```
    Get the preconfigured hosts licensed
    
    Returns:
    
    the list of preconfigured hosts licensed (MICHAELS, IBM IE, GXS, KOHLS, EDS_ELIT, WAL_MART, ASDA); empty list if all hosts available
    
    Throws:
    
    java.rmi.RemoteException
  - getActiveHostLimit
```
int getActiveHostLimit()
                throws java.rmi.RemoteException
```
    Get the license active host limit; <=0 indicates no limit
    
    Returns:
    
    the active host limit
    
    Throws:
    
    java.rmi.RemoteException
  - getActiveMailboxLimit
```
int getActiveMailboxLimit()
                   throws java.rmi.RemoteException
```
    Get the license active mailbox limit; <=0 indicates no limit
    
    Returns:
    
    the active mailbox limit
    
    Throws:
    
    java.rmi.RemoteException
  - isMailboxLimitPerHost
```
boolean isMailboxLimitPerHost()
                       throws java.rmi.RemoteException
```
    Indicates whether the active mailbox limit is per host or overall
    
    Returns:
    
    true if active mailbox limit is per host; false if active mailbox limit is overall
    
    Throws:
    
    java.rmi.RemoteException
  - isTranslatorLicensed
```
boolean isTranslatorLicensed()
                      throws java.rmi.RemoteException
```
    Indicates whether translator integration is licensed
    
    Returns:
    
    true if translator integration is licensed
    
    Throws:
    
    java.rmi.RemoteException
  - isVLProxyLicensed
```
boolean isVLProxyLicensed()
                   throws java.rmi.RemoteException
```
    Indicates whether VLProxy usage is licensed
    
    Returns:
    
    true if VLProxy usage is licensed
    
    Throws:
    
    java.rmi.RemoteException
  - isWebBrowserLicensed
```
boolean isWebBrowserLicensed()
                      throws java.rmi.RemoteException
```
    Indicates whether web browser interface is licensed
    
    Returns:
    
    true if web browser interface is licensed
    
    Throws:
    
    java.rmi.RemoteException
  - isBackupOnly
```
boolean isBackupOnly()
              throws java.rmi.RemoteException
```
    Indicates whether can only be a backup system
    
    Returns:
    
    true if can only be a backup system
    
    Throws:
    
    java.rmi.RemoteException
  - isFipsLicensed
```
boolean isFipsLicensed()
                throws java.rmi.RemoteException
```
    Indicates whether FIPS mode is licensed
    
    Returns:
    
    true if FIPS mode is licensed
    
    Throws:
    
    java.rmi.RemoteException
  - isApiLicensed
```
boolean isApiLicensed()
               throws java.rmi.RemoteException
```
    Indicates whether application program interface (API) is licensed
    
    Returns:
    
    true if API is licensed
    
    Throws:
    
    java.rmi.RemoteException
  - isDashboards
```
boolean isDashboards()
              throws java.rmi.RemoteException
```
    Indicates whether dashboards is licensed
    
    Returns:
    
    true if dashboards is licensed
    
    Throws:
    
    java.rmi.RemoteException
  - isSystemMonitor
```
boolean isSystemMonitor()
                 throws java.rmi.RemoteException
```
    Indicates whether system monitor is licensed
    
    Returns:
    
    true if system monitor is licensed
    
    Throws:
    
    java.rmi.RemoteException
  - isSNMPAgent
```
boolean isSNMPAgent()
             throws java.rmi.RemoteException
```
    Indicates whether SNMP agent is licensed
    
    Returns:
    
    true if SNMP agent is licensed
    
    Throws:
    
    java.rmi.RemoteException
  - isIPFilter
```
boolean isIPFilter()
            throws java.rmi.RemoteException
```
    Indicates whether IP filtering is licensed
    
    Returns:
    
    true if IP filtering is licensed
    
    Throws:
    
    java.rmi.RemoteException
  - isPerProtocol
```
boolean isPerProtocol()
               throws java.rmi.RemoteException
```
    Indicates whether mailbox licensing is per protocol
    
    Returns:
    
    true if mailbox licensing is per protocol
    
    Throws:
    
    java.rmi.RemoteException
  - getProtocolLimit
```
long getProtocolLimit(com.cleo.lexicom.beans.LicenseFields.Protocol protocol)
               throws java.rmi.RemoteException
```
    Get the mailbox limit for a protocol
    
    Parameters:
    
    protocol - the protocol limit
    
    Returns:
    
    -1 if the protocol is not allowed, 0 if the protocol is unlimited, and >0 is the protocol has a specific limit
    
    Throws:
    
    java.rmi.RemoteException
  - isJavaScriptActions
```
boolean isJavaScriptActions()
                     throws java.rmi.RemoteException
```
    Indicates whether JavaScript actions are licensed (not applicable to LexiCom)
    
    Returns:
    
    true if JavaScript actions are licensed
    
    Throws:
    
    java.rmi.RemoteException
  - getTriggerPoolSize
```
long getTriggerPoolSize()
                 throws java.rmi.RemoteException
```
    Get the trigger pool size (not applicable to LexiCom)
    
    Returns:
    
    the trigger pool size
    
    Throws:
    
    java.rmi.RemoteException
  - isTrustLicensed
```
boolean isTrustLicensed()
                 throws java.rmi.RemoteException
```
    Indicates whether trust is licensed
    
    Returns:
    
    true if trust is licensed
    
    Throws:
    
    java.rmi.RemoteException
  - isUnifyLicensed
```
boolean isUnifyLicensed()
                 throws java.rmi.RemoteException
```
    Indicates whether unify is licensed
    
    Returns:
    
    true if unify is licensed
    
    Throws:
    
    java.rmi.RemoteException
  - getSupportExpiration
```
java.util.Date getSupportExpiration()
                             throws java.rmi.RemoteException
```
    Get the support expiration date; null is no expiration set in license
    
    Returns:
    
    the support expiration date
    
    Throws:
    
    java.rmi.RemoteException
  - getActiveHostCount
```
long getActiveHostCount()
                 throws java.lang.Exception
```
    Get the number of active hosts
    
    Returns:
    
    the number of active hosts
    
    Throws:
    
    java.lang.Exception
  - getActiveMailboxCount
```
long[] getActiveMailboxCount()
                      throws java.lang.Exception
```
    Get the number of active mailboxes
    
    Returns:
    
    The number of active mailboxes and LDAP users int[0]=Number of non-LDAP mailboxes int[1]=Number of LDAP users
    
    Throws:
    
    java.lang.Exception
  - getActiveProtocolCount
```
long[] getActiveProtocolCount(com.cleo.lexicom.beans.LicenseFields.Protocol protocol)
                       throws java.lang.Exception
```
    Get the number of active hosts or mailboxes for each protocol. If isMailboxLimitPerHost() is true, then hosts per protocol is returned. If isMailboxLimitPerHost() is false, then mailboxes per protocol is returned.
    
    Parameters:
    
    protocol - The protocol for which to get the active counts
    
    Returns:
    
    The number of hosts or mailboxes for the protocol int[0]=Number of non-LDAP hosts or mailboxes for the protocol int[1]=Number of LDAP users for the protocol
    
    Throws:
    
    java.lang.Exception

Interface ILicense

Field Summary

Method Summary

Field Detail

LEXICOM

VLTRADER

HARMONY

WINDOWS

UNIX

AS400

MICHAELS

IBM_IE

GXS

WAL_MART

KOHLS

EDS_ELIT

ASDA

Method Detail

getProduct

getPlatform

getSerialNumber

getOwner

getHostID

getKeyHostID

isTemporary

isSubscription

getKeyExpiration

getAllowedHosts

getActiveHostLimit

getActiveMailboxLimit

isMailboxLimitPerHost

isTranslatorLicensed

isVLProxyLicensed

isWebBrowserLicensed

isBackupOnly

isFipsLicensed

isApiLicensed

isDashboards

isSystemMonitor

isSNMPAgent

isIPFilter

isPerProtocol

getProtocolLimit

isJavaScriptActions

getTriggerPoolSize

isTrustLicensed

isUnifyLicensed

getSupportExpiration

getActiveHostCount

getActiveMailboxCount

getActiveProtocolCount