com.adobe.pdfg.service.api

Interface PDFGConfigService

public interface PDFGConfigService

Method Summary

Modifier and Type	Method and Description
String	getActionTaggedXML(String sName, String jName, String fName, int timeout, boolean skipValidation) This method returns the text for Action Tagged XML.
Map<String,Map>	getAllSettingsMapWithDefault() This method returns all filetypes settings, Adobe PDF Settings & security Settings.
Map	getAllValidUsersAccounts() This method returns a map containing all valid user accounts.
String	getClearText(String enc) This method returns clear text from cipher text.
List<List<String>>	getColorProfiles() This method returns a list containing three lists of gray,rbb,cmy profiles
String	getConfigurationSetting(String key) This method returns the specified configuration setting.
Map	getConfigurationSettingsMap() This method returns a map of configuration settings.
String	getConfigurationXML() This method returns the text for configuration XML.
String	getConfigurationXML(String sName, String jName, String fName) This method returns the text for configuration XML with the names of security setting, filetype setting and job options as specified by the arguments.
List<List<String>>	getCSFAndEmbeddedProfiles(String noneLocalized) This method returns a list containing two List objects.
Map	getDefaultSettingsNames() This method returns a map containing names of default job options, security settings and filetype settings.
Map	getFiletypeSettingByName(String fsname) This method returns a map of named filetype settings.
Map	getFiletypeSettingsMap() This method returns a map of filetype settings.
List	getFontFolders() This method returns a list of all font folders.
List	getFontsInFolder(String folderPath) This method returns a list of all fonts in the specified folder.
Map<String,String[]>	getGeneralConfigMap() This API returns the map of general configuration of PDFG.
Map	getJobOptionMapByName(String jname) This method returns a map of named job options.
Map	getJobOptionsMap() This method returns a map of job options.
String	getJobOptionStringByName(String jname) This method returns the raw data for job options string with the name as specified by the argument.
Map<String,List<String>>	getOSAndUsers() This API has been added specifically for LCM user screen.
String	getPDFExportXML(String exportFormat, int timeout) This method returns the text for PDF Export XML.
Map	getPDFGProductInfo() This method returns the text for PDF Generator product info.
List<File>	getPDFGTempFolders() This API return the temporary PDF Folders list which needs to be cleaned up.
Map	getPrologue() This method returns the a map containing prologue and epilogue files.
Map	getSecuritySettingByName(String sname) This method returns a map of named security settings.
Map	getSecuritySettingsMap() This method returns a map of security Settings.
Map<String,String>	getUserAccountsMap() This API returns the map of all the user accounts present.
void	importConfigurationXML(String configXML) Imports a given configuration XML into the JCR.
void	removeFiletypeSettings(List fnames) Removes an array of all the filetype settings(if present) that are passed by the user
void	removeJobOptionSettings(List jobOptNames) Removes an array of all the job option settings(if present) that are passed by the user
void	removeSecuritySettings(List secSettNames) Removes an array of all the security settings(if present) that are passed by the user
void	removeUserAccounts(List users) Removes an array of all the user accounts(if present) that are passed by the user
void	resetConfigurationToDefault() Resets configuration to default configuration shipped with PDF Generator.
void	setDefaultSettings(String sname, String jname, String aname) Sets the settings with specified names as default settings.
void	setJobOptionsByName(String jobName, String jobOptionData) Sets an array of all the job options that are passed by the user
void	setPrologue(Map pmap) Sets the map containing prologue and epilogue files
void	updateFiletypeSettings(Map fsMap, boolean createNew) Sets an array of all the filetype settings that are passed by the user.
void	updateGeneralConfig(Map<String,String[]> generalConfig) This API updates the map of general configuration of PDFG.
void	updateJobOptions(Map jobOptionsMap, boolean createNew) Sets an array of all the job options that are passed by the user
void	updateSecuritySetting(String settingName, String openPassword, String permPassword) Updates the named security setting passed by the user
void	updateSecuritySettings(Map ssMap, boolean createNew) Sets an array of all the security settings that are passed by the user.
void	updateUserAccountsSettings(Map userInfoMap, boolean createNew) Sets an user account setting that is passed by the user
Map	validateAllUsersCredentials() This method validates all user credentials and returns map containing the user-name : valid/invalid status.
boolean	validateUserCredentials(String userName, String domainName, String password) This method validates the supplied user credentials and returns true if they are correct.

Method Detail

getJobOptionsMap

Map getJobOptionsMap()
              throws ConfigException

This method returns a map of job options.

Returns:

Map

Throws:

ConfigLockException

ConfigLoadException

ConfigException

getSecuritySettingsMap

Map getSecuritySettingsMap()
                    throws ConfigException

This method returns a map of security Settings.

Returns:

Map

Throws:

ConfigException

getFiletypeSettingsMap

Map getFiletypeSettingsMap()
                    throws ConfigException

This method returns a map of filetype settings.

Returns:

Map

Throws:

ConfigException

getClearText

String getClearText(String enc)
             throws ConfigException

This method returns clear text from cipher text.

Throws:

ConfigException

getJobOptionMapByName

Map getJobOptionMapByName(String jname)
                   throws ConfigException

This method returns a map of named job options.

Parameters:

jname -

Returns:

Map

Throws:

ConfigException

getJobOptionStringByName

String getJobOptionStringByName(String jname)
                         throws ConfigException

This method returns the raw data for job options string with the name as specified by the argument. This is used for downloading job options.

Returns:

String

Throws:

ConfigException

getSecuritySettingByName

Map getSecuritySettingByName(String sname)
                      throws ConfigException

This method returns a map of named security settings.

Parameters:

sname -

Returns:

Map

Throws:

ConfigException

getFiletypeSettingByName

Map getFiletypeSettingByName(String fsname)
                      throws ConfigException

This method returns a map of named filetype settings.

Parameters:

fsname -

Returns:

Map

Throws:

ConfigException

getConfigurationXML

String getConfigurationXML()
                    throws ConfigException

This method returns the text for configuration XML.

Returns:

String

Throws:

ConfigException

getConfigurationXML

String getConfigurationXML(String sName,
                           String jName,
                           String fName)
                    throws ConfigException,
                           ConversionException

This method returns the text for configuration XML with the names of security setting, filetype setting and job options as specified by the arguments.

Parameters:

sName -

jName -

fName -

Throws:

ConfigException

ConversionException

getPDFExportXML

String getPDFExportXML(String exportFormat,
                       int timeout)
                throws ConfigException,
                       ConversionException

This method returns the text for PDF Export XML.

Parameters:

exportFormat -

timeout -

Returns:

String

Throws:

ConfigException

ConversionException

getActionTaggedXML

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

This method returns the text for Action Tagged XML.

Parameters:

sName -

jName -

fName -

Throws:

ConfigException

ConversionException

getDefaultSettingsNames

Map getDefaultSettingsNames()
                     throws ConfigException

This method returns a map containing names of default job options, security settings and filetype settings.

Returns:

Map

Throws:

ConfigException

getPDFGProductInfo

Map getPDFGProductInfo()
                throws ConfigException

This method returns the text for PDF Generator product info.

Returns:

Map

Throws:

ConfigException

getPrologue

Map getPrologue()
         throws ConfigException

This method returns the a map containing prologue and epilogue files.

Returns:

The map containing prologue and epilogue files

Throws:

ConfigException

setPrologue

void setPrologue(Map pmap)
          throws ConfigException

Sets the map containing prologue and epilogue files

Parameters:

pmap -

Throws:

ConfigException

getFontFolders

List getFontFolders()
             throws ConfigException

This method returns a list of all font folders.

Returns:

List of all the font folders

Throws:

ConfigException

getFontsInFolder

List getFontsInFolder(String folderPath)
               throws ConfigException

This method returns a list of all fonts in the specified folder.

Parameters:

folderPath -

Returns:

Fonts in the specified folder

Throws:

ConfigException

updateJobOptions

void updateJobOptions(Map jobOptionsMap,
                      boolean createNew)
               throws ConfigException

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

Parameters:

jobOptionsMap - 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(String jobName,
                         String jobOptionData)
                  throws ConfigException

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

Parameters:

jobName -

jobOptionData -

Throws:

ConfigException

updateSecuritySetting

void updateSecuritySetting(String settingName,
                           String openPassword,
                           String permPassword)
                    throws ConfigException

Updates the named security setting passed by the user

Parameters:

settingName - The security setting to be updated

openPassword - The Document Open password. Leave unchanged if null, remove if blank.

permPassword - The Permissions password. Leave unchanged if null, remove if blank.

Throws:

ConfigException

updateSecuritySettings

void updateSecuritySettings(Map ssMap,
                            boolean createNew)
                     throws ConfigException

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

Parameters:

ssMap - 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(Map fsMap,
                            boolean createNew)
                     throws ConfigException

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

Parameters:

fsMap -

createNew -

Throws:

ConfigException

removeSecuritySettings

void removeSecuritySettings(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(List fnames)
                     throws ConfigException

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

Parameters:

fnames -

Throws:

ConfigException

removeJobOptionSettings

void removeJobOptionSettings(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(String sname,
                        String jname,
                        String aname)
                 throws ConfigException,
                        ConversionException

Sets the settings with specified names as default settings.

Parameters:

sname -

jname -

aname -

Throws:

ConfigException

ConversionException

importConfigurationXML

void importConfigurationXML(String configXML)
                     throws ConfigException

Imports a given configuration XML into the JCR.

Parameters:

configXML -

Throws:

ConfigException

resetConfigurationToDefault

void resetConfigurationToDefault()
                          throws ConfigException

Resets configuration to default configuration shipped with PDF Generator.

Throws:

ConfigException

getConfigurationSettingsMap

Map getConfigurationSettingsMap()

This method returns a map of configuration settings.

Returns:

Map

getConfigurationSetting

String getConfigurationSetting(String key)

This method returns the specified configuration setting.

Parameters:

key -

Returns:

String

getCSFAndEmbeddedProfiles

List<List<String>> getCSFAndEmbeddedProfiles(String noneLocalized)
                                      throws ConfigException

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

Returns:

List

Throws:

ConfigException

getColorProfiles

List<List<String>> getColorProfiles()
                             throws ConfigException

This method returns a list containing three lists of gray,rbb,cmy profiles

Returns:

List respectively.

Throws:

ConfigException

getAllSettingsMapWithDefault

Map<String,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(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

getGeneralConfigMap

Map<String,String[]> getGeneralConfigMap()
                                  throws ConfigException

This API returns the map of general configuration of PDFG. The structure of the Map is Map

Returns:

Map of general configuration

Throws:

ConfigException

updateGeneralConfig

void updateGeneralConfig(Map<String,String[]> generalConfig)
                  throws ConfigException

This API updates the map of general configuration of PDFG. The structure of the Map is Map

Parameters:

generalConfig - Map of general configuration

Throws:

ConfigException

getUserAccountsMap

Map<String,String> 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(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(String userName,
                                String domainName,
                                String password)
                         throws ConfigException

This method validates the supplied user credentials and returns true if they are correct.

Parameters:

userName -

domainName -

password -

Returns:

true if user credentials provided are correct

Throws:

ConfigException

validateAllUsersCredentials

Map validateAllUsersCredentials()
                         throws ConfigException

This method validates all user credentials and returns map containing the user-name : valid/invalid status.

Returns:

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

Throws:

ConfigException

getOSAndUsers

Map<String,List<String>> 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

List<File> 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

getAllValidUsersAccounts

Map getAllValidUsersAccounts()
                      throws ConfigException

This method returns a map containing all valid user accounts.

Returns:

Map

Throws:

ConfigException