com.jalios.jcms.publiclink

Class PublicLink

java.lang.Object

com.jalios.jstore.BasicStorable

com.jalios.jcms.Data

com.jalios.jcms.publiclink.PublicLink

All Implemented Interfaces:

DBData, JcmsConstants, ImportConstants, MashupConstants, Storable, JaliosConstants, LangPropertyArgument, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<BasicStorable>

public class PublicLink
extends Data
implements DBData

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.jalios.jcms.Data

Data.AuthorComparator<T extends Data>, Data.AuthorizedSelector, Data.AuthorSelector, Data.CdateSelector, Data.DataNameComparator<T extends Data>, Data.DeletableSelector, Data.ImportSelector, Data.MdateSelector, Data.OpAuthorComparator<T extends Data>, Data.RowIdComparator<T extends Data>, Data.StrongLockSelector

Nested classes/interfaces inherited from class com.jalios.jstore.BasicStorable

BasicStorable.CdateComparator<T extends Storable>, BasicStorable.IdComparator<T extends Storable>, BasicStorable.MdateComparator<T extends Storable>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACL_CAN_CREATE
static java.lang.String	ACL_CAN_MANAGE
static java.lang.String	CONCEALED_ACCESSID_FIELD
static int	CURRENT_VERSION
static java.lang.String	DOC_LIST_FIELD
protected java.util.List<java.lang.String>	docFileList
protected java.util.List<FileDocument>	docList
protected java.util.List<java.lang.String>	docVersionList
static java.lang.String	EXPIRY_DATE_FIELD
static int	FROZEN_VERSION
static int	ORIGINAL_FILE_TYPE
static int	PDF_FILE_TYPE

Fields inherited from class com.jalios.jcms.Data

author, authorDBID, channel, DISPLAY_URL_EXTRA_INFO, extension, extraDataMap, extraDBDataMapToSaveOnOp, importMap, opAuthor, opDelegate, REVISION

Fields inherited from class com.jalios.jstore.BasicStorable

cdate, ddate, id, mdate, store

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Fields inherited from interface com.jalios.jcms.mashup.ImportConstants

IMPORT_ALARM_MGR, IMPORT_AUTHOR_PROP, IMPORT_CATEGORY_DEFAULT, IMPORT_DC_ATTR, IMPORT_DC_STEP, IMPORT_DIR, IMPORT_ENABLED, IMPORT_JDOM_ELEMENT, IMPORT_LOG_FILE, IMPORT_LOG_MAX, IMPORT_OPTIONS, IMPORT_OPTIONS_DC_CONTEXT, IMPORT_ROOT_PROP, IMPORT_SOURCE_FILE, IMPORT_SOURCE_PREFIX_PROP, IMPORT_SOURCES_DIR, IMPORT_STEP_CLEAN, IMPORT_STEP_IMPORT, IMPORT_STEP_UPDATE_REF, IMPORT_WS_PROP

Fields inherited from interface com.jalios.jcms.mashup.MashupConstants

DATA_TAG, DATASET_TAG, FIELD_CLASS, FIELD_ENTRY, FIELD_ITEM, FIELD_KEY, FIELD_NAME, FIELD_TAG, FIELD_VALUE, FILE_FIELD, FILE_ID, FILE_MTIME, FILE_SIZE, FILE_TAG, FILE_TICKET, FILESET_TAG, RELATED_TAG

Constructor Summary

Constructors

Constructor and Description
PublicLink()
PublicLink(PublicLink other)

Method Summary

Modifier and Type	Method and Description
boolean	canBeReadBy(Member member, boolean searchInGroups, RightInfo rightInfo) Checks if the specified member is authorized to read this Data.
boolean	checkAccessCode(java.lang.String code)
ControllerStatus	checkWrite(int op, Member mbr, boolean checkIntegrity, java.util.Map context) Checks if the given write operation can be performed
java.lang.String	getAccessCode()
java.lang.String	getAccessId()
java.lang.String	getAccessUrl()
java.lang.String	getConcealedAccessCode()
java.lang.String	getConcealedAccessId()
java.util.List<java.lang.String>	getDocFileList()
java.util.List<FileDocument>	getDocList()
java.util.List<FileDocument>	getDocList(boolean modifiable)
java.util.List<java.lang.String>	getDocListId() Do not call this method.
java.util.List<java.lang.String>	getDocVersionList()
int	getDownloadCount()
java.util.List<PublicDownload>	getDownloadList()
java.util.Date	getExpiryDate()
int	getFileType()
java.lang.String	getMailBody(java.lang.String lang, java.util.Locale locale)
java.lang.String	getMailSubject(java.lang.String lang)
int	getMaxDownload()
java.lang.String	getName()
java.lang.String	getRemainingDuration(java.util.Locale locale)
int	getVersion()
boolean	hasAccessCode()
void	initializeDBDataCollections() This methods force the collections of the DBData to be initialized()
boolean	isCurrentVersion()
boolean	isFrozenVersion()
boolean	isOriginalFileType()
boolean	isPDFFileType()
boolean	isZip()
protected void	performAfterWrite(int op, Member mbr, java.util.Map context) Called to perform some action after the write.
protected void	performBeforeWrite(int op, Member mbr, java.util.Map context) Called to perform some action before the write.
void	setAccessCode(java.lang.String accessCode)
void	setAccessId(java.lang.String accessId)
void	setConcealedAccessCode(java.lang.String concealedAccessCode)
void	setConcealedAccessId(java.lang.String concealedAccessId)
void	setDocFileList(java.util.List<java.lang.String> docFileList)
void	setDocList(java.util.List<FileDocument> v)
void	setDocListId(java.util.List<java.lang.String> v) Do not call this method.
void	setDocVersionList(java.util.List<java.lang.String> docVersionList)
void	setExpiryDate(java.util.Date expiryDate)
void	setFileType(int fileType)
void	setMaxDownload(int maxDownload)
void	setName(java.lang.String name)
void	setVersion(int version)

Methods inherited from class com.jalios.jcms.Data

canBeReadBy, canBeUnlockedBy, canRequestUnlock, checkAndPerformCreate, checkAndPerformCreate, checkAndPerformDelete, checkAndPerformDelete, checkAndPerformUpdate, checkAndPerformUpdate, checkCreate, checkCreate, checkDelete, checkDelete, checkIntegrity, checkIntegrity, checkLockMember, checkMember, checkStrongLockMember, checkStrongLockMember, checkUpdate, checkUpdate, cleanHybridCollection, cleanHybridCollection, cleanHybridCollection, cleanHybridCollections, clone, computeDBIDArray, computeDBIDList, computeDBIDSet, exportXml, exportXml, exportXml, exportXml, exportXmlField, exportXmlRelated, exportXmlRelated, fillExportXmlFieldAttributes, getAllReferrerSet, getAllReferrerSet, getAllTypeFieldEntry, getAuthor, getAuthor, getAuthorComparator, getAuthorDBID, getAuthorId, getAuthorSelector, getBooleanFieldValue, getBooleanFieldValue, getCaddyComparator, getCategoryFieldValue, getCategoryFieldValue, getCdateSelector, getComparator, getCSVHeader, getDataIcon, getDataIconAlt, getDataIconCSS, getDataIconHtml, getDataIconHtml, getDataIconTitle, getDataImage, getDataImage, getDataImage, getDataName, getDataNameComparator, getDate, getDate, getDateSelector, getDeletableSelector, getDisplayLink, getDisplayLink, getDisplayLink, getDisplayLinkCss, getDisplayLinkDataAttribute, getDisplayLinkHtmlAttributes, getDisplayUrl, getDoubleFieldValue, getDoubleFieldValue, getExportXmlDataValue, getExtension, getExtraData, getExtraDataMap, getExtraDBData, getExtraDBDataMap, getExtraInfo, getExtraInfoMap, getFieldStatusMap, getFieldValue, getFieldValue, getFieldValue, getFieldValue, getGenericThumbnail, getGenericThumbnail, getImportAuthor, getImportBatch, getImportDate, getImportDisplayUrl, getImportId, getImportMap, getImportMdate, getImportSelector, getImportSignature, getImportSource, getImportSourceUrl, getImportUrl, getIntFieldValue, getIntFieldValue, getLangPropertyValue, getLinkCount, getLinkIndexedDataSet, getLinkIndexedDataSet, getLockDate, getLockInfo, getLockMember, getLongFieldValue, getLongFieldValue, getMdateSelector, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getOpAuthor, getOpAuthorComparator, getOpAuthorId, getOpDelegate, getReadAuthorizedSelector, getReferrerSet, getRowId, getRowIdComparator, getStrongLock, getStrongLockContext, getStrongLockContextData, getStrongLockDate, getStrongLockInfo, getStrongLockMember, getStrongLockSelector, getTypeEntry, getTypeFieldsEntries, getUpdateInstance, getVirtualIDSet, importXml, importXmlFieldsWithReferences, importXmlFiles, importXmlReferences, isDBData, isImported, isImportUpdated, isInDatabase, isLocked, isPersisted, isStrongLocked, lock, markNewImport, mergeHybridLink, mergeHybridLink, performCreate, performCreate, performDelete, performDelete, performUpdate, performUpdate, prepareUpdateContext, printDataName, printDisplayLinkEnd, printDisplayLinkStart, printDisplayLinkStart, printDisplayUrl, printDisplayUrl, putStrongLock, putStrongLock, releaseStrongLock, releaseStrongLock, removeExtraData, removeExtraDBData, removeExtraInfo, setAuthor, setAuthorDBID, setAuthorId, setBooleanFieldValue, setCategoryFieldValue, setDoubleFieldValue, setExtension, setExtraData, setExtraDataMap, setExtraDBData, setExtraDBDataMap, setExtraDBDataMap, setExtraInfo, setFieldValue, setFieldValue, setId, setImportAuthor, setImportBatch, setImportDate, setImportDisplayUrl, setImportId, setImportMap, setImportMdate, setImportSignature, setImportSource, setImportSourceUrl, setImportUpdated, setIntFieldValue, setLongFieldValue, setMdate, setOpAuthor, setOpAuthorId, setOpDelegate, setRowId, splitHybridCollections, toCSV, toFullString, toString, unlock, unlock, unmarkNewImport, updateDisplayLinkCss, updateDisplayLinkDataAttribute, updateDisplayLinkHtmlAttributes, updateExtraDataMap, updateExtraDBDataMap, updateIndexTreeSet

Methods inherited from class com.jalios.jstore.BasicStorable

clearId, compareTo, equals, getAttribute, getAttributes, getCdate, getCdateComparator, getDdate, getId, getIdComparator, getMdate, getMdateComparator, getStore, getUrid, hasBeenUpdated, hashCode, isStored, resolveAtt, resolveVal, setAttributes, setAttributes, setCdate, setDdate, setStore, toXml

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.jalios.jcms.db.DBData

getRowId, setRowId

Field Detail

DOC_LIST_FIELD

public static final java.lang.String DOC_LIST_FIELD

See Also:

Constant Field Values

CONCEALED_ACCESSID_FIELD

public static final java.lang.String CONCEALED_ACCESSID_FIELD

See Also:

Constant Field Values

EXPIRY_DATE_FIELD

public static final java.lang.String EXPIRY_DATE_FIELD

See Also:

Constant Field Values

ORIGINAL_FILE_TYPE

public static final int ORIGINAL_FILE_TYPE

See Also:

Constant Field Values

PDF_FILE_TYPE

public static final int PDF_FILE_TYPE

See Also:

Constant Field Values

CURRENT_VERSION

public static final int CURRENT_VERSION

See Also:

Constant Field Values

FROZEN_VERSION

public static final int FROZEN_VERSION

See Also:

Constant Field Values

ACL_CAN_CREATE

public static final java.lang.String ACL_CAN_CREATE

See Also:

Constant Field Values

ACL_CAN_MANAGE

public static final java.lang.String ACL_CAN_MANAGE

See Also:

Constant Field Values

docList

protected transient java.util.List<FileDocument> docList

docFileList

protected java.util.List<java.lang.String> docFileList

docVersionList

protected java.util.List<java.lang.String> docVersionList

Constructor Detail

PublicLink

public PublicLink()

PublicLink

public PublicLink(PublicLink other)

Method Detail

hasAccessCode

public boolean hasAccessCode()

Returns:

true if this public link requires an access code.

Since:

jcms-10.0.5

getAccessUrl

public java.lang.String getAccessUrl()

Returns:

the access URL for this public link

Since:

jcms-10.0.5

getDownloadCount

public int getDownloadCount()

Returns:

the count of PublicDownload for this PublicLink

Since:

jcms-10.0.5

getDownloadList

public java.util.List<PublicDownload> getDownloadList()

Returns:

the list of all PublicDownload for this PublicLink

Since:

jcms-10.0.5

checkAccessCode

public boolean checkAccessCode(java.lang.String code)

Parameters:

code - the code to check

Returns:

true if the given code is correct

Since:

jcms-10.0.5

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getExpiryDate

public java.util.Date getExpiryDate()

setExpiryDate

public void setExpiryDate(java.util.Date expiryDate)

getConcealedAccessId

public java.lang.String getConcealedAccessId()

setConcealedAccessId

public void setConcealedAccessId(java.lang.String concealedAccessId)

getAccessId

public java.lang.String getAccessId()

setAccessId

public void setAccessId(java.lang.String accessId)

getConcealedAccessCode

public java.lang.String getConcealedAccessCode()

setConcealedAccessCode

public void setConcealedAccessCode(java.lang.String concealedAccessCode)

getAccessCode

public java.lang.String getAccessCode()

setAccessCode

public void setAccessCode(java.lang.String accessCode)

getFileType

public int getFileType()

setFileType

public void setFileType(int fileType)

getVersion

public int getVersion()

setVersion

public void setVersion(int version)

getMaxDownload

public int getMaxDownload()

setMaxDownload

public void setMaxDownload(int maxDownload)

getDocFileList

public java.util.List<java.lang.String> getDocFileList()

setDocFileList

public void setDocFileList(java.util.List<java.lang.String> docFileList)

getDocVersionList

public java.util.List<java.lang.String> getDocVersionList()

setDocVersionList

public void setDocVersionList(java.util.List<java.lang.String> docVersionList)

getDocList

public java.util.List<FileDocument> getDocList()

getDocList

public java.util.List<FileDocument> getDocList(boolean modifiable)

setDocList

public void setDocList(java.util.List<FileDocument> v)

getDocListId

public java.util.List<java.lang.String> getDocListId()

Do not call this method. It is reserved for DBData mapping.

Returns:

the doc id set

setDocListId

public void setDocListId(java.util.List<java.lang.String> v)

Do not call this method. It is reserved for DBData mapping.

Parameters:

v - the doc id set

initializeDBDataCollections

public void initializeDBDataCollections()

Description copied from class: Data

This methods force the collections of the DBData to be initialized()

Overrides:

initializeDBDataCollections in class Data

checkWrite

public ControllerStatus checkWrite(int op,
                                   Member mbr,
                                   boolean checkIntegrity,
                                   java.util.Map context)

Description copied from class: Data

Checks if the given write operation can be performed

Overrides:

checkWrite in class Data

Parameters:

op - the operation (OP_CREATE, OP_UPDATE, ...)

mbr - the member which requests the write operation

checkIntegrity - if true, requires the constraints integrity to be checked

context - a map which contains context parameters (may be null)

Returns:

a ControllerStatus

performBeforeWrite

protected void performBeforeWrite(int op,
                                  Member mbr,
                                  java.util.Map context)

Description copied from class: Data

Called to perform some action before the write.

Overrides:

performBeforeWrite in class Data

Parameters:

op - the operation (OP_CREATE, OP_UPDATE, ...)

mbr - the member which requests the write operation

context - a map which contains context parameters (may be null)

performAfterWrite

protected void performAfterWrite(int op,
                                 Member mbr,
                                 java.util.Map context)

Description copied from class: Data

Called to perform some action after the write.

Overrides:

performAfterWrite in class Data

Parameters:

op - the operation (OP_CREATE, OP_UPDATE, ...)

mbr - the member which requests the write operation

context - a map which contains context parameters (may be null)

getRemainingDuration

public java.lang.String getRemainingDuration(java.util.Locale locale)

Parameters:

locale - the locale to use

Returns:

the durations (in days) to the expiry date.

Since:

jcms-10.0.5

isCurrentVersion

public boolean isCurrentVersion()

Returns:

true if the version to download is the current version

Since:

jcms-10.0.5

isFrozenVersion

public boolean isFrozenVersion()

Returns:

true if the version to download is the "frozen" version

Since:

jcms-10.0.5

isOriginalFileType

public boolean isOriginalFileType()

Returns:

true if the fileType is Original Type

Since:

jcms-10.0.5

isPDFFileType

public boolean isPDFFileType()

Returns:

true if the fileType is PDF

Since:

jcms-10.0.5

isZip

public boolean isZip()

Returns:

true if this publicLink contains more than 1 document

Since:

jcms-10.0.5

getMailSubject

public java.lang.String getMailSubject(java.lang.String lang)

Parameters:

lang - the language to use

Returns:

the subject of the mail

Since:

jcms-10.0.5

getMailBody

public java.lang.String getMailBody(java.lang.String lang,
                                    java.util.Locale locale)

Parameters:

lang - the language to use

locale - the locale

Returns:

the body of the mail

Since:

jcms-10.0.5

canBeReadBy

public boolean canBeReadBy(Member member,
                           boolean searchInGroups,
                           RightInfo rightInfo)

Description copied from class: Data

Checks if the specified member is authorized to read this Data.

Overrides:

canBeReadBy in class Data

Parameters:

member - the member to check (may be null for anonymous user)

searchInGroups - set to true to check for read right authorization using Member's group(s).

rightInfo - a RightInfo instance in which explanation of read right authorization acceptance or refusal will be indicated. Value is required and cannot be null.

Returns:

true if the member can read this Data, false otherwise