com.tsgrp.opencontent.core.license

Class OCLicenseManager

java.lang.Object

com.tsgrp.opencontent.core.license.OCLicenseManager

public class OCLicenseManager
extends java.lang.Object

OCMS License Manager

Copyright © Technology Services Group, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LICENSE_EXPIRING_SOON
static java.lang.String	LICENSE_INVALID
static java.lang.String	LICENSE_INVALID_EXPIRED
static java.lang.String	LICENSE_INVALID_TOO_MANY_USERS
static java.lang.String	LICENSE_SERVER_ERROR
static java.lang.String	LICENSE_TYPE_FLOATING
static java.lang.String	LICENSE_TYPE_TEXT
static java.lang.String	LICENSE_VALID

Method Summary

Modifier and Type	Method and Description
boolean	addLicense(java.lang.String licenseString, java.lang.String licenseType) Adds a license to OC.
int	getDaysLeftUntilExpired() Gets the amount of days left on the license until expiration.
static OCLicenseManager	getInstance() Retrieves the license manager instance and attempts to validate it if one of the following occurs: The license was never validated previously A previously validated license exits the idle period The license was marked invalid
OCMSLicenseInfo	getLicenseDetails() Gets the details for the current OCMS license, preferring the floating license first
java.lang.String	getOCLicenseStatus() Gets the current license status for OC.
static boolean	validateOAUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String ticket) Checks that the user has permission to use the OA viewer mode on the request To use a read-only viewer, the user must be in either the viewers or annotators group To use any other viewer, the user must be in the annotators group
java.lang.String	validateOCLicense() Validates the OC license.

Methods inherited from class java.lang.Object

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

Field Detail

LICENSE_VALID

public static final java.lang.String LICENSE_VALID

See Also:

Constant Field Values

LICENSE_EXPIRING_SOON

public static final java.lang.String LICENSE_EXPIRING_SOON

See Also:

Constant Field Values

LICENSE_INVALID_EXPIRED

public static final java.lang.String LICENSE_INVALID_EXPIRED

See Also:

Constant Field Values

LICENSE_INVALID_TOO_MANY_USERS

public static final java.lang.String LICENSE_INVALID_TOO_MANY_USERS

See Also:

Constant Field Values

LICENSE_SERVER_ERROR

public static final java.lang.String LICENSE_SERVER_ERROR

See Also:

Constant Field Values

LICENSE_INVALID

public static final java.lang.String LICENSE_INVALID

See Also:

Constant Field Values

LICENSE_TYPE_TEXT

public static final java.lang.String LICENSE_TYPE_TEXT

See Also:

Constant Field Values

LICENSE_TYPE_FLOATING

public static final java.lang.String LICENSE_TYPE_FLOATING

See Also:

Constant Field Values

Method Detail

getInstance

public static OCLicenseManager getInstance()

Retrieves the license manager instance and attempts to validate it if one of the following occurs:

• The license was never validated previously
• A previously validated license exits the idle period
• The license was marked invalid

Returns:

the OCLicenseManager

getOCLicenseStatus

public java.lang.String getOCLicenseStatus()

Gets the current license status for OC.

Returns:

The current license status for OpenContent

getDaysLeftUntilExpired

public int getDaysLeftUntilExpired()

Gets the amount of days left on the license until expiration.

Returns:

the number of days remaining on the license

validateOCLicense

public java.lang.String validateOCLicense()

Validates the OC license. This method will prefer the online license first if available. Otherwise, the offline text license will be the fallback.

Returns:

String the validation status

validateOAUser

public static boolean validateOAUser(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response,
                                     java.lang.String ticket)
                              throws java.io.IOException

Checks that the user has permission to use the OA viewer mode on the request To use a read-only viewer, the user must be in either the viewers or annotators group To use any other viewer, the user must be in the annotators group

Parameters:

request -

response -

ticket -

Returns:

false - if the user is unauthorized to use the viewer requested, true otherwise

Throws:

java.io.IOException

addLicense

public boolean addLicense(java.lang.String licenseString,
                          java.lang.String licenseType)

Adds a license to OC. If the license is valid.... Writes to a license string to the configured license location. This method will only write to the license file if the license is valid.

Parameters:

licenseString - the license text

licenseType - the type of the license LICENSE_TYPE_FLOATING or LICENSE_TYPE_TEXT

Returns:

boolean indicating whether or not the write succeeds

getLicenseDetails

public OCMSLicenseInfo getLicenseDetails()
                                  throws java.text.ParseException

Gets the details for the current OCMS license, preferring the floating license first

Returns:

An OCMSLicenseInfo POJO containing license details

Throws:

java.text.ParseException