public class ProfileRealmManager extends GenericService
Modifier and Type | Class and Description |
---|---|
class |
ProfileRealmManager.ProfileRealmException |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
DEFAULT_REALM_ID |
static java.lang.String |
PROFILE_ITEM_TYPE |
static java.lang.String |
PROFILE_REALM_ITEM_TYPE |
static java.lang.String |
PUSH_REALM_PARAM_NAME |
static java.lang.String |
REALM_DESCRIPTION_PROPERTY_NAME |
static java.lang.String |
REALM_ID_PROPERTY |
static java.lang.String |
REALM_NAME_PROPERTY_NAME |
static java.lang.String |
SITE_ITEM_TYPE |
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
ProfileRealmManager()
Constructs an instanceof ProfileRealmManager
|
Modifier and Type | Method and Description |
---|---|
boolean |
canShareableJoinSiteGroup(java.lang.String pShareableId,
SiteGroup pSiteGroup)
check to see if a shareable type can be added to a site group, given
the constraints on nucleus component sharing groups not spanning multiple realms
|
boolean |
canShareableJoinSiteGroup(java.lang.String pShareableId,
java.lang.String pSiteGroupId)
check to see if a shareable type can be added to a site group, given
the constraints on nucleus component sharing groups not spanning multiple realms
|
boolean |
canShareableJoinSiteGroup(java.lang.String pShareableId,
java.lang.String pSiteGroupId,
java.util.HashSet<Site> pCurrentSiteGroupSites)
check to see if a shareable type can be added to a site group, given
the constraints on nucleus component sharing groups not spanning multiple realms
|
boolean |
canSiteJoinRealm(java.lang.String pSiteId,
java.lang.String pRealmId)
check to see if a site can belong to a specified realm, given
the constraints on nucleus component sharing groups not spanning multiple realms
|
boolean |
canSiteJoinSiteGroup(java.lang.String pSiteId,
SiteGroup pSiteGroup)
check to see if a site can belong to a site group, given
the constraints on nucleus component sharing groups not spanning multiple realms
|
boolean |
canSiteJoinSiteGroup(java.lang.String pSiteId,
java.lang.String pSiteGroupId)
check to see if a site can belong to a site group, given
the constraints on nucleus component sharing groups not spanning multiple realms
|
boolean |
canSiteJoinSiteGroup(java.lang.String pSiteId,
java.lang.String pSiteGroupId,
java.util.Collection<Site> pExistedSites,
java.util.HashSet<ShareableType> pShareableTypes)
check to see if a site can belong to a site group, given
the constraints on nucleus component sharing groups not spanning multiple realms
|
protected boolean |
checkRequiredProperties()
check to make sure all properties are set for
this service.
|
protected javax.servlet.Servlet |
createAdminServlet()
create the admin servlet
|
MutableRepositoryItem |
createRealm(java.lang.String pRealmId,
java.lang.String pRealmName,
java.lang.String pRealmDescription)
create a new profileRealm item
|
void |
deleteRealm(java.lang.String pRealmId)
delete a profile realm if there are no
sites in the realm.
|
RepositoryItem[] |
getAllRealms()
get an array of all profileRealm items
|
RepositoryItem |
getCurrentRealm()
get the profile realm for the current site
|
static java.lang.String |
getCurrentRealmId()
get the profile realm id for the current site
|
int |
getProfileCountForRealm(java.lang.String pRealmId)
get the number of profiles associated with a given
realm
|
MutableRepository |
getProfileRepository()
get ProfileRepository
|
RepositoryItem |
getRealm(java.lang.String pRealmId)
get a profile realm
|
RepositoryItem |
getRealmForSite(java.lang.String pSiteId)
get a profile realm
|
java.lang.String |
getRealmIdForSite(java.lang.String pSiteId)
get a profile realm id
|
SiteGroupManager |
getSiteGroupManager()
get SiteGroupManager
|
Repository |
getSiteRepository()
get SiteRepository
|
RepositoryItem[] |
getSitesInRealm(java.lang.String pRealmId)
get all the site repository items in a given realm
|
atg.multisite.SiteStorageAdapter |
getSiteStorageAdapter()
get SiteStorageAdapter
|
static java.lang.String |
getStackRealmId()
Gets the profile realm id from the realm id stack.
|
javax.transaction.TransactionManager |
getTransactionManager()
get TransactionManager
|
boolean |
isCurrentlyDefaultRealm() |
boolean |
isProfileRealmsEnabled()
get ProfileRealmsEnabled
|
protected void |
logPropertyNotSetErrorNoRepeat(java.lang.String pErrorKey)
display an error related to a required property setting
|
java.lang.String |
popRealmId(java.lang.String pRealmId)
pop a profile realm id off the stack
|
boolean |
pushRealmId(java.lang.String pRealmId)
push a profile realm id on the stack
|
void |
setForceEnabled()
set the force enabled thread local
|
void |
setProfileRealmsEnabled(boolean pProfileRealmsEnabled)
set ProfileRealmsEnabled
|
void |
setProfileRepository(MutableRepository pProfileRepository)
set ProfileRepository
|
void |
setSiteGroupManager(SiteGroupManager pSiteGroupManager)
set SiteGroupManager
|
void |
setSiteRepository(Repository pSiteRepository)
set SiteRepository
|
void |
setSiteStorageAdapter(atg.multisite.SiteStorageAdapter pSiteStorageAdapter)
set SiteStorageAdapter
|
void |
setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
set TransactionManager
|
void |
unsetForceEnabled()
unset the force enabled thread local
|
void |
updateRealm(java.lang.String pRealmId,
java.lang.String pRealmName,
java.lang.String pRealmDescription)
update a profileRealm item
|
addLogListener, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
public static final java.lang.String DEFAULT_REALM_ID
public static final java.lang.String PROFILE_REALM_ITEM_TYPE
public static final java.lang.String SITE_ITEM_TYPE
public static final java.lang.String PROFILE_ITEM_TYPE
public static final java.lang.String REALM_ID_PROPERTY
public static final java.lang.String REALM_NAME_PROPERTY_NAME
public static final java.lang.String REALM_DESCRIPTION_PROPERTY_NAME
public static final java.lang.String PUSH_REALM_PARAM_NAME
public ProfileRealmManager()
public void setProfileRealmsEnabled(boolean pProfileRealmsEnabled)
pProfileRealmsEnabled
- the ProfileRealmsEnabledpublic boolean isProfileRealmsEnabled()
public void setProfileRepository(MutableRepository pProfileRepository)
pProfileRepository
- the ProfileRepositorypublic MutableRepository getProfileRepository()
public void setSiteRepository(Repository pSiteRepository)
pSiteRepository
- the SiteRepositorypublic Repository getSiteRepository()
public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
pTransactionManager
- the TransactionManagerpublic javax.transaction.TransactionManager getTransactionManager()
public void setSiteStorageAdapter(atg.multisite.SiteStorageAdapter pSiteStorageAdapter)
pSiteStorageAdapter
- the SiteStorageAdapterpublic atg.multisite.SiteStorageAdapter getSiteStorageAdapter()
public void setSiteGroupManager(SiteGroupManager pSiteGroupManager)
pSiteGroupManager
- the SiteGroupManagerpublic SiteGroupManager getSiteGroupManager()
public RepositoryItem getRealm(java.lang.String pRealmId)
pRealmId
- the id of the realm we're trying to getpublic RepositoryItem getRealmForSite(java.lang.String pSiteId)
pSiteId
- the id of the site whose realm we are gettingpublic java.lang.String getRealmIdForSite(java.lang.String pSiteId)
pSiteId
- the id of the site whose realm we are gettingpublic RepositoryItem getCurrentRealm()
public static java.lang.String getCurrentRealmId()
public static java.lang.String getStackRealmId()
public boolean isCurrentlyDefaultRealm()
public boolean pushRealmId(java.lang.String pRealmId)
pRealmId
- the realm id to push on to the top of the stack. If value is null,
then the default realm id constant will be pushed on to the stack.public java.lang.String popRealmId(java.lang.String pRealmId)
pRealmId
- the realm id that is expected to be popped off
of the top of the stack.public MutableRepositoryItem createRealm(java.lang.String pRealmId, java.lang.String pRealmName, java.lang.String pRealmDescription) throws RepositoryException
pRealmId
- the id of the new realmpRealmName
- the name of the new realmpRealmDescription
- the description text for the
new realmRepositoryException
- if there was a repository
error creating the new profileRealmpublic void updateRealm(java.lang.String pRealmId, java.lang.String pRealmName, java.lang.String pRealmDescription) throws RepositoryException
pRealmId
- the id of the existing realmpRealmName
- the possibly updated realm name valuepRealmDescription
- the possibly updated realm description valueRepositoryException
- if there was a repository
error updating the profileRealm itempublic void deleteRealm(java.lang.String pRealmId) throws RepositoryException
pRealmId
- the id of the realm to deleteRepositoryException
- if there are still sites
in the realmpublic RepositoryItem[] getAllRealms()
public RepositoryItem[] getSitesInRealm(java.lang.String pRealmId)
pRealmId
- the id of the realm for which to get all the sitespublic int getProfileCountForRealm(java.lang.String pRealmId)
pRealmId
- public boolean canSiteJoinRealm(java.lang.String pSiteId, java.lang.String pRealmId)
pSiteId
- the id of the site to add to the realmpRealmId
- the id of the realm that the site will be added topublic boolean canSiteJoinSiteGroup(java.lang.String pSiteId, java.lang.String pSiteGroupId)
pSiteId
- the id of the site to add to the realmpSiteGroupId
- the id of the site group that the site will be added topublic boolean canSiteJoinSiteGroup(java.lang.String pSiteId, SiteGroup pSiteGroup)
pSiteId
- the id of the site to add to the realmpSiteGroup
- the site group that the site will be added topublic boolean canSiteJoinSiteGroup(java.lang.String pSiteId, java.lang.String pSiteGroupId, java.util.Collection<Site> pExistedSites, java.util.HashSet<ShareableType> pShareableTypes)
pSiteId
- the id of the site to add to the realmpSiteGroupId
- the id of the site group that the site will be added topExistedSites
- the current sites of site group, both persisted and not persisted
Null value means that sites should be retrieved from the siteGroup itself, empty value is the value
of the current editor condition with no site.pShareableTypes
- the current condition of shareable typespublic boolean canShareableJoinSiteGroup(java.lang.String pShareableId, java.lang.String pSiteGroupId)
pShareableId
- the id of the shareable type to add to the realmpSiteGroupId
- the id of the site group that the shareable type will be added topublic boolean canShareableJoinSiteGroup(java.lang.String pShareableId, java.lang.String pSiteGroupId, java.util.HashSet<Site> pCurrentSiteGroupSites)
pShareableId
- the id of the shareable type to add to the realmpSiteGroupId
- the id of the site group that the shareable type will be added topCurrentSiteGroupSites
- the current sites of site group, both persisted and not persisted
Null value means that sites should be retrieved from the siteGroup itself, empty value is the value
of the current editor condition with no site.public boolean canShareableJoinSiteGroup(java.lang.String pShareableId, SiteGroup pSiteGroup)
pShareableId
- the id of the shareable type to add to the realmpSiteGroup
- the site group that the shareable type will be added toprotected void logPropertyNotSetErrorNoRepeat(java.lang.String pErrorKey)
pErrorKey
- the resource key for the error messageprotected boolean checkRequiredProperties()
protected javax.servlet.Servlet createAdminServlet()
createAdminServlet
in class GenericService
public void setForceEnabled()
public void unsetForceEnabled()