com.adobe.pdfg.config
Interface PDFGConfigService

public interface PDFGConfigService

Method Summary

java.lang.String	getActionTaggedXML(java.lang.String sName, java.lang.String jName, java.lang.String fName, int timeout, boolean skipValidation)
java.util.Map	getAllSettingsMapWithDefault() This method returns all filetypes settings, Adobe PDF Settings & security Settings.
java.lang.String	getClearText(java.lang.String enc)
java.util.List	getColorProfiles()
java.lang.String	getConfigurationSetting(java.lang.String key)
java.util.Map	getConfigurationSettingsMap()
java.lang.String	getConfigurationXML()
java.lang.String	getConfigurationXML(java.lang.String sName, java.lang.String jName, java.lang.String fName)
java.util.List	getCSFAndEmbeddedProfiles(java.lang.String noneLocalized)
java.util.Map	getDefaultSettingsNames()
java.util.Map	getFiletypeSettingByName(java.lang.String fsname)
java.util.Map	getFiletypeSettingsMap()
java.util.List	getFontFolders()
java.util.List	getFontsInFolder(java.lang.String folderPath)
java.util.Map	getIPPSettings(java.util.Map ippMap, boolean createNew)
java.util.Map	getJobOptionMapByName(java.lang.String jname)
java.util.Map	getJobOptionsMap()
java.lang.String	getJobOptionStringByName(java.lang.String jname)
java.lang.String	getJobOptionStringByNameLegacy(java.lang.String jname)
java.util.Map	getOSAndUsers() This API has been added specifically for LCM user screen.
java.lang.String	getPDFExportXML(java.lang.String exportFormat, int timeout)
java.util.Map	getPDFGProductInfo()
java.util.List	getPDFGTempFolders() This API return the temporary PDF Folders list which needs to be cleaned up.
java.util.Map	getPrologue()
java.util.Map	getSecuritySettingByName(java.lang.String sname)
java.util.Map	getSecuritySettingsMap()
java.util.Map	getUserAccountsMap() This API returns the map of all the user accounts present.
void	importConfigurationXML(java.lang.String configXML)
boolean	isGeneratorInstalled()
boolean	isPostScriptInstalled()
void	publishUpdateMessages()
void	removeFiletypeSettings(java.util.List fnames)
void	removeJobOptionSettings(java.util.List jobOptNames) Removes an array of all the job option settings(if present) that are passed by the user
void	removeSecuritySettings(java.util.List secSettNames) Removes an array of all the security settings(if present) that are passed by the user
void	removeUserAccounts(java.util.List users) Removes an array of all the user accounts(if present) that are passed by the user
void	resetConfigurationToDefault()
void	setDefaultSettings(java.lang.String sname, java.lang.String jname, java.lang.String aname)
void	setJobOptionsByName(java.lang.String jobName, java.lang.String jobOptionData) Sets an array of all the job options that are passed by the user
void	setPrologue(java.util.Map pmap)
void	updateFiletypeSettings(java.util.Map fsMap, boolean createNew)
void	updateIPPSettings(java.util.Map ippMap, boolean createNew)
void	updateJobOptions(java.util.Map jobOptionsMap, boolean createNew) Sets an array of all the job options that are passed by the user
void	updateSecuritySettings(java.util.Map ssMap, boolean createNew) Sets an array of all the security settings that are passed by the user
void	updateUserAccountsSettings(java.util.Map userInfoMap, boolean createNew) Sets an user account setting that is passed by the user
java.util.Map	validateAllUsersCredentials()
boolean	validateUserCredentials(java.lang.String userName, java.lang.String domainName, java.lang.String password)

Method Detail

getJobOptionsMap

java.util.Map getJobOptionsMap()
                               throws ConfigException

Returns:

Throws:

ConfigLockException

ConfigLoadException

ConfigException

getSecuritySettingsMap

java.util.Map getSecuritySettingsMap()
                                     throws ConfigException

Returns:

Map

Throws:

ConfigException

getFiletypeSettingsMap

java.util.Map getFiletypeSettingsMap()
                                     throws ConfigException

Returns:

Throws:

ConfigException

getClearText

java.lang.String getClearText(java.lang.String enc)
                              throws ConfigException

Throws:

ConfigException

getJobOptionMapByName

java.util.Map getJobOptionMapByName(java.lang.String jname)
                                    throws ConfigException

Parameters:

jname -

Returns:

Throws:

ConfigException

getJobOptionStringByName

java.lang.String getJobOptionStringByName(java.lang.String jname)
                                          throws ConfigException

Parameters:

jname -

Returns:

Throws:

ConfigException

getJobOptionStringByNameLegacy

java.lang.String getJobOptionStringByNameLegacy(java.lang.String jname)
                                                throws ConfigException

Parameters:

jname -

Returns:

Throws:

ConfigException

getSecuritySettingByName

java.util.Map getSecuritySettingByName(java.lang.String sname)
                                       throws ConfigException

Parameters:

sname -

Returns:

Throws:

ConfigException

getFiletypeSettingByName

java.util.Map getFiletypeSettingByName(java.lang.String fsname)
                                       throws ConfigException

Parameters:

fsname -

Returns:

Throws:

ConfigException

getConfigurationXML

java.lang.String getConfigurationXML()
                                     throws ConfigException

Parameters:

location -

Throws:

ConfigException

getConfigurationXML

java.lang.String getConfigurationXML(java.lang.String sName,
                                     java.lang.String jName,
                                     java.lang.String fName)
                                     throws ConfigException,
                                            ConversionException

Parameters:

sName -

jName -

fName -

Throws:

ConfigException

ConversionException

getPDFExportXML

java.lang.String getPDFExportXML(java.lang.String exportFormat,
                                 int timeout)
                                 throws ConfigException,
                                        ConversionException

Parameters:

exportFormat -

timeout -

Returns:

Throws:

ConfigException

ConversionException

getActionTaggedXML

java.lang.String getActionTaggedXML(java.lang.String sName,
                                    java.lang.String jName,
                                    java.lang.String fName,
                                    int timeout,
                                    boolean skipValidation)
                                    throws ConfigException,
                                           ConversionException

Parameters:

sName -

jName -

fName -

Throws:

ConfigException

ConversionException

getDefaultSettingsNames

java.util.Map getDefaultSettingsNames()
                                      throws ConfigException

Parameters:

location -

Throws:

ConfigException

getPDFGProductInfo

java.util.Map getPDFGProductInfo()
                                 throws ConfigException

Throws:

ConfigException

getPrologue

java.util.Map getPrologue()
                          throws ConfigException

Returns:

The map containing prologue and epilogue files

Throws:

ConfigException

setPrologue

void setPrologue(java.util.Map pmap)
                 throws ConfigException

Throws:

ConfigException

getFontFolders

java.util.List getFontFolders()
                              throws ConfigException

Parameters:

folderPath -

Returns:

List of all the font folders Else returns the fonts in the specified folder

Throws:

ConfigException

getFontsInFolder

java.util.List getFontsInFolder(java.lang.String folderPath)
                                throws ConfigException

Parameters:

folderPath -

Returns:

Fonts in the specified folder

Throws:

ConfigException

updateJobOptions

void updateJobOptions(java.util.Map jobOptionsMap,
                      boolean createNew)
                      throws ConfigException

Sets an array of all the job options that are passed by the user

Parameters:

jobOptSettings - The JobOptions Map to be updated/created in the configuration

createNew - Specifies whether new job options will be added into configuration or not. If false, no new job options will be added into configuration

Throws:

ConfigException

setJobOptionsByName

void setJobOptionsByName(java.lang.String jobName,
                         java.lang.String jobOptionData)
                         throws ConfigException

Sets an array of all the job options that are passed by the user

Parameters:

jobOptSettings - The JobOptions objects to be updated/created in the configuration

createNew - Specifies whether new watch folders will be added into configuration or not. If false, no new job options will be added into configuration

Throws:

ConfigException

updateSecuritySettings

void updateSecuritySettings(java.util.Map ssMap,
                            boolean createNew)
                            throws ConfigException

Sets an array of all the security settings that are passed by the user

Parameters:

securitySettings - The SecuritySettings objects to be updated/created in the configuration

createNew - Specifies whether new security settings will be added into configuration or not. If false, no new security settings will be added into configuration

Throws:

ConfigException

updateFiletypeSettings

void updateFiletypeSettings(java.util.Map fsMap,
                            boolean createNew)
                            throws ConfigException

Parameters:

fsMapList -

createNew -

Throws:

ConfigException

removeSecuritySettings

void removeSecuritySettings(java.util.List secSettNames)
                            throws ConfigException

Removes an array of all the security settings(if present) that are passed by the user

Parameters:

secSettNames - The names of the security settings to remove

Throws:

ConfigException

removeFiletypeSettings

void removeFiletypeSettings(java.util.List fnames)
                            throws ConfigException

Parameters:

fnames -

Throws:

ConfigException

removeJobOptionSettings

void removeJobOptionSettings(java.util.List jobOptNames)
                             throws ConfigException

Removes an array of all the job option settings(if present) that are passed by the user

Parameters:

jobOptNames - The names of the job option (settings) to remove

Throws:

ConfigException

setDefaultSettings

void setDefaultSettings(java.lang.String sname,
                        java.lang.String jname,
                        java.lang.String aname)
                        throws ConfigException,
                               ConversionException

Parameters:

location -

Throws:

ConfigException

ConversionException

publishUpdateMessages

void publishUpdateMessages()
                           throws ConfigException

Parameters:

location -

Throws:

ConfigException

getIPPSettings

java.util.Map getIPPSettings(java.util.Map ippMap,
                             boolean createNew)
                             throws ConfigException

Throws:

ConfigException

importConfigurationXML

void importConfigurationXML(java.lang.String configXML)
                            throws ConfigException

Parameters:

location -

Throws:

ConfigException

updateIPPSettings

void updateIPPSettings(java.util.Map ippMap,
                       boolean createNew)
                       throws java.lang.Exception

Throws:

java.lang.Exception

resetConfigurationToDefault

void resetConfigurationToDefault()
                                 throws ConfigException

Throws:

ConfigException

isPostScriptInstalled

boolean isPostScriptInstalled()

isGeneratorInstalled

boolean isGeneratorInstalled()

getConfigurationSettingsMap

java.util.Map getConfigurationSettingsMap()

getConfigurationSetting

java.lang.String getConfigurationSetting(java.lang.String key)

getCSFAndEmbeddedProfiles

java.util.List getCSFAndEmbeddedProfiles(java.lang.String noneLocalized)
                                         throws ConfigException

Returns:

a list containing two List objects. First one is list of settings names. The first setting is a empty string. The second list contains names of color profiles in these setting files.

Throws:

ConfigException

getColorProfiles

java.util.List getColorProfiles()
                                throws ConfigException

Returns:

a list containing three lists of gray,rbb,cmy profiles respectively.

Throws:

ConfigException

getAllSettingsMapWithDefault

java.util.Map getAllSettingsMapWithDefault()
                                           throws ConfigException

This method returns all filetypes settings, Adobe PDF Settings & security Settings. Each setting has the flag attached to it whether it is ReadOnly and/or default or not.

Returns:

- Map of PDFG settings

Throws:

ConfigException

updateUserAccountsSettings

void updateUserAccountsSettings(java.util.Map userInfoMap,
                                boolean createNew)
                                throws ConfigException

Sets an user account setting that is passed by the user

Parameters:

userInfoMap - The userInfo object to be updated/created in the configuration

createNew - Specifies whether new user account settings will be added into configuration or not. If false, no new user account settings will be added into configuration

Throws:

ConfigException

getUserAccountsMap

java.util.Map getUserAccountsMap()
                                 throws ConfigException

This API returns the map of all the user accounts present. The structure of the Map is Map

Returns:

- Map of user accounts

Throws:

ConfigException

removeUserAccounts

void removeUserAccounts(java.util.List users)
                        throws ConfigException

Removes an array of all the user accounts(if present) that are passed by the user

Parameters:

users - The names of the users to remove

Throws:

ConfigException

validateUserCredentials

boolean validateUserCredentials(java.lang.String userName,
                                java.lang.String domainName,
                                java.lang.String password)
                                throws ConfigException

Parameters:

userName -

domainName -

password -

Returns:

true if user credentials provided are correct

Throws:

ConfigException

validateAllUsersCredentials

java.util.Map validateAllUsersCredentials()
                                          throws ConfigException

Returns:

the map containing the user-name : valid/invalid status.

Throws:

ConfigException

getOSAndUsers

java.util.Map getOSAndUsers()
                            throws ConfigException

This API has been added specifically for LCM user screen. This returns the OperationgSystem of the LC server as the Key of the map and a list of users added as the value.

Returns:

Map

Throws:

ConfigException

getPDFGTempFolders

java.util.List getPDFGTempFolders()
                                  throws ConfigException

This API return the temporary PDF Folders list which needs to be cleaned up.

Returns:

- List of Folder paths as strings

Throws:

ConfigException