| java.lang.Object
 org.opencms.publish.CmsPublishJobInfoBean
| CmsPublishJobInfoBean | | final public class CmsPublishJobInfoBean (Code) | | Publish job information bean.
author:
Michael Moossen
version:
$Revision: 1.5 $
since:
6.5.5 |
| Field Summary | |
| final public static int | C_PUBLISH_FLAG
The flag used to indicate a direct publish job. |
| Constructor Summary | |
| public | CmsPublishJobInfoBean(CmsUUID historyId, CmsUUID projectId, String projectName, CmsUUID userId, String localeName, int flags, int resourceCount, long enqueueTime, long startTime, long finishTime)
| | protected | CmsPublishJobInfoBean(CmsObject cms, CmsPublishList publishList, I_CmsReport report)
|
| C_PUBLISH_FLAG | | final public static int C_PUBLISH_FLAG(Code) | | The flag used to indicate a direct publish job.
|
| CmsPublishJobInfoBean | | public CmsPublishJobInfoBean(CmsUUID historyId, CmsUUID projectId, String projectName, CmsUUID userId, String localeName, int flags, int resourceCount, long enqueueTime, long startTime, long finishTime)(Code) | | Constructor used to initialize a job info bean from the database.
Parameters:
historyId - publish history id
Parameters:
projectId - the id of the project
Parameters:
projectName - the name of the project
Parameters:
userId - the id of the user
Parameters:
localeName - the string representation of a locale
Parameters:
flags - flags of the publish job
Parameters:
resourceCount - number of published resources
Parameters:
enqueueTime - time when the job was enqueued
Parameters:
startTime - time when the job was started
Parameters:
finishTime - time when the job was finished |
| CmsPublishJobInfoBean | | protected CmsPublishJobInfoBean(CmsObject cms, CmsPublishList publishList, I_CmsReport report) throws CmsException(Code) | | The Default constructor.
Parameters:
cms - the cms context to use for publishing
Parameters:
publishList - the list of resources to publish
Parameters:
report - the report to write to
throws:
CmsException - if something goes wrong |
| enqueue | | protected void enqueue()(Code) | | Signalizes that the publish job has been enqueued.
Actually sets the enqueue time only if it is not set already (re-enqueue during startup).
|
| finish | | protected void finish()(Code) | | Signalizes the end of the publish job.
Actually only sets the finish time and closes the publish report stream.
|
| getCmsObject | | protected CmsObject getCmsObject()(Code) | | Returns the cms object, will be set to null after publishing.
the cms object |
| getEnqueueTime | | public long getEnqueueTime()(Code) | | Returns the time this object has been created.
the time this object has been created |
| getFinishTime | | public long getFinishTime()(Code) | | Returns the time the publish job ends.
the time the publish job ends |
| getFlags | | public int getFlags()(Code) | | Returns the flags of this publish job.
the flags of this publish job |
| getLocale | | public Locale getLocale()(Code) | | Returns the locale for this publish job.
the locale for this publish job |
| getProjectId | | public CmsUUID getProjectId()(Code) | | Returns the project id for this publish job.
the project id for this publish job |
| getProjectName | | public String getProjectName()(Code) | | Returns the originally stored project name.
the originally stored project name |
| getPublishHistoryId | | public CmsUUID getPublishHistoryId()(Code) | | Returns the publish history id.
the publish history id |
| getPublishList | | public CmsPublishList getPublishList()(Code) | | Returns the list of resources to publish.
the list of resources to publish |
| getPublishReport | | public I_CmsReport getPublishReport()(Code) | | Returns the report for this publish job.
This is not the original report, it is wrapper that
also writes to a temporary file.
It will be null before starting and after finishing.
the report for this publish job
See Also: CmsPublishJobEnqueued.getReport |
| getReport | | public I_CmsReport getReport()(Code) | | Returns the report for this publish job.
the report for this publish job |
| getSize | | public int getSize()(Code) | | Returns the number of resources in the publish list.
the number of resources in the publish list |
| getStartTime | | public long getStartTime()(Code) | | Returns the time the publish job did actually start.
the time the publish job did actually start |
| getThreadUUID | | public CmsUUID getThreadUUID()(Code) | | Returns the UUID of the running publish thread.
the UUID of the running publish thread |
| getUserId | | public CmsUUID getUserId()(Code) | | Returns the user for this publish job.
the user for this publish job |
| isDirectPublish | | protected boolean isDirectPublish()(Code) | | Returns true if this is a "direct publish" operation.
true if this is a "direct publish" operation |
| isFinished | | protected boolean isFinished()(Code) | | Returns if the publish job is already finished.
true if the publish job is already finished |
| isStarted | | protected boolean isStarted()(Code) | | Returns if the publish job is already started.
true if the publish job is already started |
| removePublishReport | | public I_CmsReport removePublishReport()(Code) | | Removes the assigned publish report.
the removed report |
| start | | protected void start(CmsUUID threadUUID)(Code) | | Signalizes the start of the publish job.
Actually sets the starting time, writes the report header and sets the running thread uuid.
Parameters:
threadUUID - the running thread uuid |
|
|