com.edorasware.commons.core.content

Interface ContentPreProcessingConfiguration

All Known Implementing Classes:

DefaultContentPreProcessingConfiguration

public interface ContentPreProcessingConfiguration

The content pre processing configuration which is used to pre process content added/updated in the ContentManager. The whole pre processing is build upon Spring Batch.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_INFO_PROPERTIES_JOB_PARAMETER_KEY The content info job parameter holds the content info of the content to be added/updated.
static String	CONTENT_META_DATA_JOB_PARAMETER_KEY The content metadata job parameter which holds the content metadata of the content to be added/updated.
static String	CONTENT_REFERENCE_JOB_PARAMETER_KEY The content reference job parameter which holds the content reference of the content to be added/updated.
static String	CONTENT_SCOPE_JOB_PARAMETER_KEY The content scope job parameter which holds the scope of the content to be added/updated.
static String	CURRENT_TENANT_ID_JOB_PARAMETER_KEY The current (the one used when adding/updating the content) tenant id job parameter.
static String	CURRENT_USER_ID_JOB_PARAMETER_KEY The current (the one used when adding/updating the content) user id job parameter.
static String	ENABLE_CONTENT_PRE_PROCESSING_CONTENT_INFO_PROPERTY Property used in the ContentInfo object to enable or disable the content pre processing for each added content individually.
static String	JOB_NAME The Spring Batch job name.
static String	ORIGINAL_FILE_PATH_JOB_PARAMETER_KEY The original file job parameter which holds the path to the original file which is added/updated.
static String	PROCESSED_FILE_PATH_JOB_PARAMETER_KEY The processed file job parameter which holds the path to the processed file.
static String	WORK_DIRECTORY_PATH_JOB_PARAMETER_KEY The work directory job parameter which holds the patch for the work directory of the pre processing configuration.

Method Summary

Modifier and Type	Method and Description
org.springframework.batch.core.job.AbstractJob	getJob() The job which will be started for each add/update of the content.
org.springframework.batch.core.explore.JobExplorer	getJobExplorer() Returns the JobExplorer used to browse the jobs and steps.
org.springframework.batch.core.launch.JobLauncher	getJobLauncher() Returns the JobLauncher used to launch the job retrieved with the getJob() method.
org.springframework.batch.core.repository.JobRepository	getJobRepository() Returns the JobRepository used to persist the jobs and steps.
File	getWorkDirectory() The work directory where the content pre processing job is able to store temporary files used for the pre processing.

Field Detail

JOB_NAME

static final String JOB_NAME

The Spring Batch job name.

See Also:

Constant Field Values

CURRENT_TENANT_ID_JOB_PARAMETER_KEY

static final String CURRENT_TENANT_ID_JOB_PARAMETER_KEY

The current (the one used when adding/updating the content) tenant id job parameter.

See Also:

Constant Field Values

CURRENT_USER_ID_JOB_PARAMETER_KEY

static final String CURRENT_USER_ID_JOB_PARAMETER_KEY

The current (the one used when adding/updating the content) user id job parameter.

See Also:

Constant Field Values

ORIGINAL_FILE_PATH_JOB_PARAMETER_KEY

static final String ORIGINAL_FILE_PATH_JOB_PARAMETER_KEY

The original file job parameter which holds the path to the original file which is added/updated.

See Also:

Constant Field Values

PROCESSED_FILE_PATH_JOB_PARAMETER_KEY

static final String PROCESSED_FILE_PATH_JOB_PARAMETER_KEY

The processed file job parameter which holds the path to the processed file. The job will pre process the ORIGINAL_FILE_PATH_JOB_PARAMETER_KEY file and then store it in the processed file path.

See Also:

Constant Field Values

WORK_DIRECTORY_PATH_JOB_PARAMETER_KEY

static final String WORK_DIRECTORY_PATH_JOB_PARAMETER_KEY

The work directory job parameter which holds the patch for the work directory of the pre processing configuration.

See Also:

getWorkDirectory(), Constant Field Values

CONTENT_SCOPE_JOB_PARAMETER_KEY

static final String CONTENT_SCOPE_JOB_PARAMETER_KEY

The content scope job parameter which holds the scope of the content to be added/updated.

See Also:

Constant Field Values

CONTENT_REFERENCE_JOB_PARAMETER_KEY

static final String CONTENT_REFERENCE_JOB_PARAMETER_KEY

The content reference job parameter which holds the content reference of the content to be added/updated.

See Also:

Constant Field Values

CONTENT_META_DATA_JOB_PARAMETER_KEY

static final String CONTENT_META_DATA_JOB_PARAMETER_KEY

The content metadata job parameter which holds the content metadata of the content to be added/updated.

See Also:

Constant Field Values

CONTENT_INFO_PROPERTIES_JOB_PARAMETER_KEY

static final String CONTENT_INFO_PROPERTIES_JOB_PARAMETER_KEY

The content info job parameter holds the content info of the content to be added/updated.

See Also:

Constant Field Values

ENABLE_CONTENT_PRE_PROCESSING_CONTENT_INFO_PROPERTY

static final String ENABLE_CONTENT_PRE_PROCESSING_CONTENT_INFO_PROPERTY

Property used in the ContentInfo object to enable or disable the content pre processing for each added content individually. A value of "false" will disable the content pre processing, "true" or if the value is not set enable it.

See Also:

Constant Field Values

Method Detail

getJobExplorer

org.springframework.batch.core.explore.JobExplorer getJobExplorer()

Returns the JobExplorer used to browse the jobs and steps.

Returns:

the job explorer

getJobRepository

org.springframework.batch.core.repository.JobRepository getJobRepository()

Returns the JobRepository used to persist the jobs and steps.

Returns:

the job repository

getJobLauncher

org.springframework.batch.core.launch.JobLauncher getJobLauncher()

Returns the JobLauncher used to launch the job retrieved with the getJob() method.

Returns:

the job launcher

getJob

org.springframework.batch.core.job.AbstractJob getJob()

The job which will be started for each add/update of the content.

Returns:

the pre processing job

getWorkDirectory

File getWorkDirectory()

The work directory where the content pre processing job is able to store temporary files used for the pre processing.

Returns:

the work directory