Package org.silverpeas.core.admin.domain
Class AbstractDomainDriver
- java.lang.Object
-
- org.silverpeas.core.admin.domain.AbstractDomainDriver
-
- All Implemented Interfaces:
DomainDriver
- Direct Known Subclasses:
DomainDriverManager
,GoogleDriver
,LDAPDriver
,SCIMDriver
,SilverpeasDriver
,SQLDriver
public abstract class AbstractDomainDriver extends Object implements DomainDriver
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.silverpeas.core.admin.domain.DomainDriver
DomainDriver.ActionConstants, DomainDriver.UserFilterManager
-
-
Field Summary
Fields Modifier and Type Field Description protected int
domainId
protected List<DomainProperty>
domainProperties
protected String[]
keys
protected String[]
mapParameters
protected Map<String,HashMap<String,String>>
propertiesDescriptions
protected String
propertiesl10n
protected Map<String,HashMap<String,String>>
propertiesLabels
protected boolean
synchroInProcess
protected boolean
x509Enabled
-
Constructor Summary
Constructors Constructor Description AbstractDomainDriver()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addPropertiesToImport(List<DomainProperty> props)
void
addPropertiesToImport(List<DomainProperty> props, Map<String,String> theDescriptions)
void
beginSynchronization()
Called when Admin starts the synchronizationString
endSynchronization(boolean cancelSynchro)
Called when Admin ends the synchronizationlong
getDriverActions()
Called when Admin starts the synchronizationString[]
getMapParameters()
Map<String,String>
getPropertiesDescriptions(String language)
Map<String,String>
getPropertiesLabels(String language)
String[]
getPropertiesNames()
List<DomainProperty>
getPropertiesToImport(String language)
DomainProperty
getProperty(String propName)
protected static int
idAsInt(String id)
protected static String
idAsString(int id)
Convert int Id to String Idvoid
init(int domainId, String initParam, String authenticationServer)
Initialize the domain driver with the initialization parameter stocked in table This parameter could be a table name or a resource file name or whatever specified by the domain driver Default : resource file namevoid
initFromProperties(SettingBundle rs)
Virtual method that performs extra initialization from a properties file.boolean
isGroupsInheritProfiles()
boolean
isSynchroInProcess()
boolean
isSynchroOnLoginEnabled()
boolean
isSynchroOnLoginRecursToGroups()
boolean
isSynchroThreaded()
boolean
isX509CertificateEnabled()
boolean
mustImportUsers()
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.silverpeas.core.admin.domain.DomainDriver
createGroup, createUser, deleteGroup, deleteUser, getAllGroups, getAllRootGroups, getAllUsers, getGroup, getGroupByName, getGroupMemberGroupIds, getGroups, getUser, getUserAttributes, getUserFilterManager, getUserFull, getUserMemberGroupIds, getUsersByQuery, getUsersBySpecificProperty, importGroup, importUser, listUserFulls, listUsers, removeGroup, removeUser, resetEncryptedPassword, resetPassword, synchroGroup, synchroUser, updateGroup, updateUserDetail, updateUserFull
-
-
-
-
Field Detail
-
domainId
protected int domainId
-
domainProperties
protected List<DomainProperty> domainProperties
-
keys
protected String[] keys
-
propertiesl10n
protected String propertiesl10n
-
mapParameters
protected String[] mapParameters
-
synchroInProcess
protected boolean synchroInProcess
-
x509Enabled
protected boolean x509Enabled
-
-
Method Detail
-
init
public void init(int domainId, String initParam, String authenticationServer) throws AdminException
Initialize the domain driver with the initialization parameter stocked in table This parameter could be a table name or a resource file name or whatever specified by the domain driver Default : resource file name- Specified by:
init
in interfaceDomainDriver
- Parameters:
domainId
- id of domaininitParam
- name of resource fileauthenticationServer
- name of the authentication server (no more used yet)- Throws:
AdminException
-
getPropertiesNames
public String[] getPropertiesNames()
- Specified by:
getPropertiesNames
in interfaceDomainDriver
-
getProperty
public DomainProperty getProperty(String propName)
- Specified by:
getProperty
in interfaceDomainDriver
-
getMapParameters
public String[] getMapParameters()
- Specified by:
getMapParameters
in interfaceDomainDriver
-
getPropertiesToImport
public List<DomainProperty> getPropertiesToImport(String language)
- Specified by:
getPropertiesToImport
in interfaceDomainDriver
-
addPropertiesToImport
public void addPropertiesToImport(List<DomainProperty> props)
- Specified by:
addPropertiesToImport
in interfaceDomainDriver
-
addPropertiesToImport
public void addPropertiesToImport(List<DomainProperty> props, Map<String,String> theDescriptions)
- Specified by:
addPropertiesToImport
in interfaceDomainDriver
- Parameters:
props
-theDescriptions
-
-
getPropertiesLabels
public Map<String,String> getPropertiesLabels(String language)
- Specified by:
getPropertiesLabels
in interfaceDomainDriver
-
getPropertiesDescriptions
public Map<String,String> getPropertiesDescriptions(String language)
- Specified by:
getPropertiesDescriptions
in interfaceDomainDriver
-
initFromProperties
public void initFromProperties(SettingBundle rs) throws AdminException
Virtual method that performs extra initialization from a properties file. To overload by the class who need it.- Specified by:
initFromProperties
in interfaceDomainDriver
- Parameters:
rs
- name of resource file- Throws:
AdminException
-
getDriverActions
public long getDriverActions()
Called when Admin starts the synchronization- Specified by:
getDriverActions
in interfaceDomainDriver
-
isSynchroOnLoginEnabled
public boolean isSynchroOnLoginEnabled()
- Specified by:
isSynchroOnLoginEnabled
in interfaceDomainDriver
-
isSynchroThreaded
public boolean isSynchroThreaded()
- Specified by:
isSynchroThreaded
in interfaceDomainDriver
-
isSynchroOnLoginRecursToGroups
public boolean isSynchroOnLoginRecursToGroups()
- Specified by:
isSynchroOnLoginRecursToGroups
in interfaceDomainDriver
-
isGroupsInheritProfiles
public boolean isGroupsInheritProfiles()
- Specified by:
isGroupsInheritProfiles
in interfaceDomainDriver
-
mustImportUsers
public boolean mustImportUsers()
- Specified by:
mustImportUsers
in interfaceDomainDriver
-
isX509CertificateEnabled
public boolean isX509CertificateEnabled()
- Specified by:
isX509CertificateEnabled
in interfaceDomainDriver
-
beginSynchronization
public void beginSynchronization()
Called when Admin starts the synchronization- Specified by:
beginSynchronization
in interfaceDomainDriver
-
isSynchroInProcess
public boolean isSynchroInProcess()
- Specified by:
isSynchroInProcess
in interfaceDomainDriver
-
endSynchronization
public String endSynchronization(boolean cancelSynchro)
Called when Admin ends the synchronization- Specified by:
endSynchronization
in interfaceDomainDriver
- Parameters:
cancelSynchro
- true if the synchronization is cancelled, false if it ends normally
-
idAsInt
protected static int idAsInt(String id)
-
idAsString
protected static String idAsString(int id)
Convert int Id to String Id- Parameters:
id
- id to convert
-
-