Interface AdministrationService
- All Superinterfaces:
com.appiancorp.services.ContextSensitiveService
,Service
Methods of service classes can all throw the unchecked exception
ServiceException
if any
system-level error (for example, server failure) occurs, and will in general
throw a checked exception (InvalidXXXException
) when an entity
to be retrieved is inaccessible, instead of returning null
.
Exceptions to this paradigm (including the use of ResultList
as
described below) are noted. All checked exceptions extend
AppianException
.
It may be necessary to retrieve a subset of results as opposed to an entire
collection, and also to sort the subset by some property of the returned
object. "Paging" methods which return a
ResultPage
are provided in certain
instances for this purpose. The ResultPage
will contain the
sorted subset of results
(via Result.getResults()
), and the
total number of items in the available result set
(via ResultPage.getAvailableItems()
).
It may also be necessary to retrieve some results, even if all results
cannot be retrieved (for instance, some of the entities corresponding
to a list of entity IDs may no longer exist). Methods which return a
ResultList
are provided for this
purpose. The Result.getResults()
method in this case will return all results which can be retrieved. In
addition, there will be a list of result codes
(ResultList.getResultCodes()
) that
represent the successful retrieval of an entity, or, if the entity could
not be retrieved, the reason for the failure. See the CODE_XXX
constants in ResultList
for details.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.Fields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME
-
Method Summary
Modifier and TypeMethodDescriptionactivateUserSession
(Long[] membership_, Long[] administration_) Deprecated.void
Deprecated.findPortletTypes
(String filterMask_, String stateFilter_) Deprecated.findPortletTypesPaging
(String filterMask_, String stateFilter_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.JSR-168 and WSRP Portlets have been deprecated, and no portlets of those types will be returned by this method.Deprecated.not usedgetMultiplePortletTypes
(String[] portletTypeDefinitions_) Deprecated.usefindPortletTypesPaging(java.lang.String, java.lang.String, int, int, java.lang.Integer, java.lang.Integer)
orgetPortletTypesPaging(int, int, java.lang.Integer, java.lang.Integer)
instead JSR-168 and WSRP Portlets have been deprecated, and calls to this method for those types will throwInvalidPortletTypeDefinitionException
.getPortletType
(String portletTypeDefinition_) Deprecated.JSR-168 and WSRP Portlets have been deprecated, and calls to this method for those types will throwInvalidPortletTypeDefinitionException
.Deprecated.usegetPortletTypesPaging(int, int, Integer, Integer)
instead JSR-168 and WSRP Portlets have been deprecated, and no portlets of those types will be returned by this methodgetPortletTypesPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.JSR-168 and WSRP Portlets have been deprecated, and no portlets of those types will be returned by this method.Deprecated.Gets the calendar settings for the administration server UseGlobalizationService.getSiteCalendarSettings()
to get the calendar settings of the entire site.Deprecated.Returns the site locale settings for the administration server UseGlobalizationService.getSiteLocaleSettings()
to get site locale setting for the entire site.Deprecated.Gets the site timezone settings for the adminstration server UseGlobalizationService.getSiteTimeZoneSettings()
to get the timezone settings of the entire site.getSystemPageId
(String systemPageUuid) Deprecated.Gets the system page id corresponding to the given UUID.String[]
Deprecated.this information is no longer availablegetWSRPProducer
(Long producerId_) Deprecated.WSRP Producers have been removed in Appian 22.2.getWSRPProducerFromURL
(String producerURL_) Deprecated.WSRP Producers have been removed in Appian 22.2.getWSRPProducers
(Long[] producerIds_) Deprecated.WSRP Producers have been removed in Appian 22.2.getWSRPProducersPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.WSRP Producers have been removed in Appian 22.2.void
notifyGroupDeletion
(Long groupId_) Deprecated.Notifies that the specified group has been deleted and no references to it should therefore exist in the portal applicationvoid
notifyGroupsDeletion
(Long[] groupIds_) Deprecated.Notifies that the specified groups have been deleted and no references to them should therefore exist in the portal applicationvoid
notifyUserCreation
(String username_) Deprecated.done automatically by UserService.createUservoid
notifyUsersCreation
(String[] usernames_) Deprecated.Notifies the portal application that these users have been created.void
registerPortletType
(PortletType portletType_) Deprecated.JSR-168 and WSRP Portlets have been deprecated, and calls to this method for those types will be ignored.void
registerPortletTypes
(PortletType[] portletTypes_) Deprecated.JSR-168 and WSRP Portlets have been deprecated, and calls to this method for those types will be ignored.registerWSRPProducer
(PersistedWSRPProducer producer_) Deprecated.WSRP Producers have been removed in Appian 22.2.void
Deprecated.reloading properties is now automatic, so this call is now unnecessary and does nothing.void
Deprecated.void
Deprecated.Sets the specified group as the administrative group for the Portal application.void
setSiteCalendarSettings
(SiteCalendarSettings settings_) Deprecated.Registers the calendar setting for the administration server.void
setSiteLocaleSettings
(SiteLocaleSettings settings_) Deprecated.Registers the site local settings for the administration server.void
setSiteTimeZoneSettings
(SiteTimeZoneSettings timezoneSettings_) Deprecated.Registers the site timezone settings for the administration server.void
updatePortletTypesState
(String[] portletTypeDefinitions_, String newState_) Deprecated.JSR-168 and WSRP Portlets have been deprecated, and calls for those PortletTypes will be ignored by this methodvoid
updatePortletTypeState
(String portletTypeDefinition_, String newState_) Deprecated.JSR-168 and WSRP Portlets have been deprecated, and calls for those PortletTypes will be ignored by this methodvoid
updateUsernames
(String[] oldUsernames_, String[] newUsernames_, long maxExpirationTimeInSeconds_) Deprecated.validate()
Deprecated.use thevalidate
diagnostic script insteadboolean
validateGroupMembership
(Long[] memGroupIds_, Long[] admGroupIds_) Deprecated.No longer necessary with credential systemMethods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
registerPortletType$UPDATES
static final boolean registerPortletType$UPDATESDeprecated.- See Also:
-
registerPortletTypes$UPDATES
static final boolean registerPortletTypes$UPDATESDeprecated.- See Also:
-
getPortletType$UPDATES
static final boolean getPortletType$UPDATESDeprecated.- See Also:
-
getPortletTypes$UPDATES
static final boolean getPortletTypes$UPDATESDeprecated.- See Also:
-
getPortletTypesPaging$UPDATES
static final boolean getPortletTypesPaging$UPDATESDeprecated.- See Also:
-
getMultiplePortletTypes$UPDATES
static final boolean getMultiplePortletTypes$UPDATESDeprecated.- See Also:
-
findPortletTypes$UPDATES
static final boolean findPortletTypes$UPDATESDeprecated.- See Also:
-
findPortletTypesPaging$UPDATES
static final boolean findPortletTypesPaging$UPDATESDeprecated.- See Also:
-
updatePortletTypeState$UPDATES
static final boolean updatePortletTypeState$UPDATESDeprecated.- See Also:
-
updatePortletTypesState$UPDATES
static final boolean updatePortletTypesState$UPDATESDeprecated.- See Also:
-
registerWSRPProducer$UPDATES
static final boolean registerWSRPProducer$UPDATESDeprecated.- See Also:
-
getWSRPProducersPaging$UPDATES
static final boolean getWSRPProducersPaging$UPDATESDeprecated.- See Also:
-
getWSRPProducer$UPDATES
static final boolean getWSRPProducer$UPDATESDeprecated.- See Also:
-
getWSRPProducers$UPDATES
static final boolean getWSRPProducers$UPDATESDeprecated.- See Also:
-
getWSRPProducerFromURL$UPDATES
static final boolean getWSRPProducerFromURL$UPDATESDeprecated.- See Also:
-
notifyGroupDeletion$UPDATES
static final boolean notifyGroupDeletion$UPDATESDeprecated.- See Also:
-
notifyGroupsDeletion$UPDATES
static final boolean notifyGroupsDeletion$UPDATESDeprecated.- See Also:
-
setAdministratorGroup$UPDATES
static final boolean setAdministratorGroup$UPDATESDeprecated.- See Also:
-
activateUserSession$UPDATES
static final boolean activateUserSession$UPDATESDeprecated.- See Also:
-
notifyUserCreation$UPDATES
static final boolean notifyUserCreation$UPDATESDeprecated.- See Also:
-
notifyUsersCreation$UPDATES
static final boolean notifyUsersCreation$UPDATESDeprecated.- See Also:
-
getApplicationName$UPDATES
static final boolean getApplicationName$UPDATESDeprecated.- See Also:
-
getWorkspace$UPDATES
static final boolean getWorkspace$UPDATESDeprecated.- See Also:
-
validateGroupMembership$UPDATES
static final boolean validateGroupMembership$UPDATESDeprecated.- See Also:
-
updateUsernames$UPDATES
static final boolean updateUsernames$UPDATESDeprecated.- See Also:
-
commitUpdateUsernames$UPDATES
static final boolean commitUpdateUsernames$UPDATESDeprecated.- See Also:
-
rollbackUpdateUsernames$UPDATES
static final boolean rollbackUpdateUsernames$UPDATESDeprecated.- See Also:
-
reloadProperties$UPDATES
static final boolean reloadProperties$UPDATESDeprecated.- See Also:
-
validate$UPDATES
static final boolean validate$UPDATESDeprecated.- See Also:
-
getSiteLocaleSettings$UPDATES
static final boolean getSiteLocaleSettings$UPDATESDeprecated.- See Also:
-
setSiteLocaleSettings$UPDATES
static final boolean setSiteLocaleSettings$UPDATESDeprecated.- See Also:
-
getSiteTimeZoneSettings$UPDATES
static final boolean getSiteTimeZoneSettings$UPDATESDeprecated.- See Also:
-
setSiteTimeZoneSettings$UPDATES
static final boolean setSiteTimeZoneSettings$UPDATESDeprecated.- See Also:
-
getSiteCalendarSettings$UPDATES
static final boolean getSiteCalendarSettings$UPDATESDeprecated.- See Also:
-
setSiteCalendarSettings$UPDATES
static final boolean setSiteCalendarSettings$UPDATESDeprecated.- See Also:
-
getSystemPageId$UPDATES
static final boolean getSystemPageId$UPDATESDeprecated.- See Also:
-
-
Method Details
-
registerPortletType
Deprecated.JSR-168 and WSRP Portlets have been deprecated, and calls to this method for those types will be ignored.Register a newPortletType
. If thePortletType
is already registered (i.e. aPortletType
with the same definition already exists) the properties of the specifiedPortletType
are updated with the new values. The minimum properties which must be populated in order to register aPortletType
aredefinition
andstate
. Thedefinition
property should be a non empty string. Thestate
property can only take one of the following values: If these two properties fail to meet these requirements the respectiveportletType
won't be registered or updated.Additional constraints:
- If the
name
property is null, an empty string will be used instead. - If the
editable
property is null, false will be used instead. - All
extensions
must have a non null key. If one of the keys isnull
thePortletType
will get registered or updated using an empty set ofextensions
.
- Parameters:
portletType_
- the newPortletType
or thePortletType
to update- Throws:
NullPointerException
- ifportletType_
is null; this exception is not thrown if any of the properties is nullServiceException
- if any system-level error occurs
- If the
-
registerPortletTypes
Deprecated.JSR-168 and WSRP Portlets have been deprecated, and calls to this method for those types will be ignored.Register a list of newPortletType
objects. If thePortletType
is already registered (i.e. aPortletType
with the same definition already exists) the properties of the specifiedPortletType
are updated with the new values. The minimum properties which must be populated in order to register aPortletType
aredefinition
andstate
. Thedefinition
property should be a non empty string. Thestate
property can only take one of the following values: If these two properties fail to meet these requirements the respectivePortletType
won't be registered or updated. This won't prevent the other validPortletType
objects in the list from being registered or updated.Additional constraints:
- If any
name
property is null, an empty string will be used instead. - If any
editable
property is null, false will be used instead. - All
extensions
must have a non null key. If one of the keys isnull
thePortletType
will get registered or updated using an empty set ofextensions
.
- Parameters:
portletTypes_
- the list of newPortletType
objects or thePortletType
objects to update- Throws:
NullPointerException
- ifportletTypes_
is null; this exception is not thrown if any of the properties is nullServiceException
- if any system-level error occurs or if the list contains a null value- See Also:
- If any
-
getPortletType
@Deprecated PortletType getPortletType(String portletTypeDefinition_) throws InvalidPortletTypeDefinitionException Deprecated.JSR-168 and WSRP Portlets have been deprecated, and calls to this method for those types will throwInvalidPortletTypeDefinitionException
.Get the registered Portlet type for the requested portlet type definition- Parameters:
portletTypeDefinition_
- the definition of a portlet type- Returns:
- the portlet type
- Throws:
ServiceException
- if any system-level error occursInvalidPortletTypeDefinitionException
-
getPortletTypes
Deprecated.usegetPortletTypesPaging(int, int, Integer, Integer)
instead JSR-168 and WSRP Portlets have been deprecated, and no portlets of those types will be returned by this methodRetrieves the list of registered portlet types- Returns:
- the list of registered portlet types sorted by name
- Throws:
ServiceException
- if any system-level error occurs- See Also:
-
getPortletTypesPaging
@Deprecated ResultPage getPortletTypesPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.JSR-168 and WSRP Portlets have been deprecated, and no portlets of those types will be returned by this method.Retrieves the list of registered portlet types- Parameters:
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. use ofConstants.COUNT_ALL
will result in the entire collection being returned, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inPortletType
sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- a
ResultPage
containing the list ofPortletType
objects corresponding to the registered portlet types - Throws:
ServiceException
- if any system-level error occurs
-
getMultiplePortletTypes
@Deprecated PortletType[] getMultiplePortletTypes(String[] portletTypeDefinitions_) throws NullPointerException, InvalidPortletTypeDefinitionException Deprecated.usefindPortletTypesPaging(java.lang.String, java.lang.String, int, int, java.lang.Integer, java.lang.Integer)
orgetPortletTypesPaging(int, int, java.lang.Integer, java.lang.Integer)
instead JSR-168 and WSRP Portlets have been deprecated, and calls to this method for those types will throwInvalidPortletTypeDefinitionException
.Get the registered Portlet types for the requested portlet type definitions- Parameters:
portletTypeDefinitions_
- the list of portlet type definitions to retrieve- Returns:
- the portlet types, in the same order as the supplied definitions
- Throws:
ServiceException
- if any system-level error occursNullPointerException
InvalidPortletTypeDefinitionException
-
findPortletTypes
@Deprecated PortletType[] findPortletTypes(String filterMask_, String stateFilter_) throws NullPointerException, InvalidPortletTypeStateFilterException Deprecated.usefindPortletTypesPaging(String, String, int, int, Integer, Integer)
instead. JSR-168 and WSRP Portlets have been deprecated, and no portlets of those types will be returned by this method.- Parameters:
filterMask_
- the mask to use for the definition field, use one of the FILTER_* constants fromPortletType
stateFilter_
- which state(s) to include - use one of the STATE_* constants fromPortletType
. A null means either.- Returns:
- the list of filtered portlet types
- Throws:
NullPointerException
InvalidPortletTypeStateFilterException
-
findPortletTypesPaging
@Deprecated ResultPage findPortletTypesPaging(String filterMask_, String stateFilter_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws NullPointerException, InvalidPortletTypeStateFilterException Deprecated.JSR-168 and WSRP Portlets have been deprecated, and no portlets of those types will be returned by this method.- Parameters:
filterMask_
- the mask to use for the definition field, use one of the FILTER_* constants fromPortletType
stateFilter_
- which state(s) to include - use one of the STATE_* constants fromPortletType
or null for either.startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. Negative numbers will result in the entire collection being returned, but this is discouraged.sortProperty_
- the property by which the results should be sorted. This should be one of theSORT_BY_XXX
constants inPortletType
.sortOrder_
- the order in which to sort the results. This should be eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
.- Returns:
- the list of filtered portlet types
- Throws:
NullPointerException
InvalidPortletTypeStateFilterException
-
updatePortletTypeState
@Deprecated void updatePortletTypeState(String portletTypeDefinition_, String newState_) throws NullPointerException, InvalidPortletTypeDefinitionException, InvalidPortletTypeStateException Deprecated.JSR-168 and WSRP Portlets have been deprecated, and calls for those PortletTypes will be ignored by this methodUpdate state of a registered portlet type- Parameters:
portletTypeDefinition_
- the Portlet type definition of the portlet typenewState_
- the new state - use one of the STATE_* constants fromPortletType
- Throws:
ServiceException
- if any system-level error occursNullPointerException
InvalidPortletTypeDefinitionException
InvalidPortletTypeStateException
-
updatePortletTypesState
@Deprecated void updatePortletTypesState(String[] portletTypeDefinitions_, String newState_) throws NullPointerException, InvalidPortletTypeDefinitionException, InvalidPortletTypeStateException Deprecated.JSR-168 and WSRP Portlets have been deprecated, and calls for those PortletTypes will be ignored by this methodUpdate the state of multiple registered portlet types- Parameters:
portletTypeDefinitions_
- the list of portlet type definitions to updatenewState_
- the new state - use one of the STATE_* constants fromPortletType
- Throws:
ServiceException
- if any system-level error occursNullPointerException
InvalidPortletTypeDefinitionException
InvalidPortletTypeStateException
-
registerWSRPProducer
@Deprecated Long registerWSRPProducer(PersistedWSRPProducer producer_) throws DuplicateWSRPProducerURLException, InvalidWSRPProducerException, NullPointerException Deprecated.WSRP Producers have been removed in Appian 22.2. This method will be removed in a future release, and will now throwInvalidWSRPProducerException
Adds or updates a WSRP Producer in the system.- Parameters:
producer_
- The PersistedWSRPProducer object that will be created or updated- Returns:
- the identifier of the created or updated Producer object
- Throws:
DuplicateWSRPProducerURLException
- if the Producer URL already exists in the systemInvalidWSRPProducerException
- if the id of the producer object is invalidNullPointerException
- if the Producer URL is null or empty
-
getWSRPProducersPaging
@Deprecated ResultPage getWSRPProducersPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.WSRP Producers have been removed in Appian 22.2. This method will be removed in a future release, and will now return an empty ResultPage.Retrieves the list of registered Producers- Parameters:
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. Negative numbers will result in the entire collection being returned, but this is discouraged.sortProperty_
- the property by which the results will be sorted This is one of theSORT_BY_XXX
constants inPersistedWSRPProducer
sortOrder_
-Constants.SORT_ORDER_ASCENDING
for sorting results in ascending order,Constants.SORT_ORDER_DESCENDING
for sorting results in descending order- Returns:
- A Result Page containing the requested PersistedWSRPProducer objects
-
getWSRPProducer
@Deprecated PersistedWSRPProducer getWSRPProducer(Long producerId_) throws InvalidWSRPProducerException, NullPointerException Deprecated.WSRP Producers have been removed in Appian 22.2. This method will be removed in a future release, and will now throwInvalidWSRPProducerException
Get a registered WSRP Producer- Parameters:
producerId_
- the id of the producer- Returns:
- the producer object that has the specified id
- Throws:
InvalidWSRPProducerException
- if the specified Producer id is invalidNullPointerException
- if a null Producer id is specified
-
getWSRPProducers
@Deprecated PersistedWSRPProducer[] getWSRPProducers(Long[] producerIds_) throws InvalidWSRPProducerException, NullPointerException Deprecated.WSRP Producers have been removed in Appian 22.2. This method will be removed in a future release, and will now throwInvalidWSRPProducerException
Gets the registered Producer objects that correspond to the specified ids- Parameters:
producerIds_
- the ids of the producers- Returns:
- an array of PersistedWSRPProducer objects that match the specified id list
- Throws:
InvalidWSRPProducerException
- if any of the specified Producer ids are invalidNullPointerException
- if any of the specified Producer ids are null
-
getWSRPProducerFromURL
@Deprecated PersistedWSRPProducer getWSRPProducerFromURL(String producerURL_) throws InvalidWSRPProducerURLException, NullPointerException Deprecated.WSRP Producers have been removed in Appian 22.2. This method will be removed in a future release, and will now throwInvalidWSRPProducerURLException
Get the registered producer for specified URL (URLs are unique)- Parameters:
producerURL_
- the URL that the producer should have- Returns:
- the PersistedWSRPProducer object for the specified URL
- Throws:
InvalidWSRPProducerURLException
- if there are not Producers with the specified URLNullPointerException
- if an empty or null Producer URL is specified
-
notifyGroupDeletion
Deprecated.Notifies that the specified group has been deleted and no references to it should therefore exist in the portal application- Parameters:
groupId_
- the ID of the group that has been deleted- Throws:
PrivilegeException
- if the specified group is the portal administrator groupNullPointerException
- ifgroupId_
isnull
ServiceException
- if any system-level error occurs- See Also:
-
notifyGroupsDeletion
Deprecated.Notifies that the specified groups have been deleted and no references to them should therefore exist in the portal application- Parameters:
groupIds_
- the IDs of the groups that have been deleted- Throws:
PrivilegeException
- if any of the specified groups is the portal administrator groupNullPointerException
- ifgroupIds_
isnull
ServiceException
- if any system-level error occurs- See Also:
-
setAdministratorGroup
Deprecated.Sets the specified group as the administrative group for the Portal application. Users in the administrative group can perform any action on every object in the application, irrespective of the security settings.- Parameters:
id_
- the ID of the group to be set as administrator group- Throws:
NullPointerException
- ifid_
isnull
ServiceException
- if any system-level error occurs
-
activateUserSession
@Deprecated Void activateUserSession(Long[] membership_, Long[] administration_) throws InvalidAnonymousUserException, InvalidUserException, NullPointerException Deprecated.Notifies the portal application that a new session has been created for the current user, and provides information about the current user's membership and administration rights to groups. In Portal, this call has no side-effect other than caching the passed groups, thus this method can also be used to simply update the membership/administration information for the current user. This call is necessary every time the group membership role is changed, a new group is created, or when the user is newly created- Parameters:
membership_
- the list of group IDs of groups of which the user is a memberadministration_
- the list of group IDs of groups of which the user has administrative rights- Throws:
InvalidAnonymousUserException
- if the user calling this method is anonymous, but anonymous access has not been enabledInvalidUserException
- if the user calling this method does not existNullPointerException
- if any of the input arrays arenull
ServiceException
- if any system-level error occurs
-
notifyUserCreation
Deprecated.done automatically by UserService.createUserNotifies the portal application that this user has been created. This should be called after a user has been created usingUserService.createUser(com.appiancorp.suiteapi.personalization.User)
.The caller should take care to only pass the valid username of a user that has been previously created in
UserService
.- Parameters:
username_
- the username of the created user- Throws:
NullPointerException
- ifusername_
isnull
or emptyServiceException
- if any system-level error occurs
-
notifyUsersCreation
Deprecated.Notifies the portal application that these users have been created. This should be called after users have been created usingUserService.createUser(com.appiancorp.suiteapi.personalization.User)
orUserService.createUsers(com.appiancorp.suiteapi.personalization.User[])
.The caller should take care to only pass the valid username of a user that has been previously created in
UserService
.- Parameters:
usernames_
- the usernames of the created users- Throws:
NullPointerException
- if the passedusernames_
array or any of its elements isnull
or emptyServiceException
- if any system-level error occurs
-
getApplicationName
Deprecated.not usedGets the name of the application on which this service is running.- Returns:
- the name of the application
- Throws:
ServiceException
- if any system-level error occurs
-
getWorkspace
Deprecated.this information is no longer availableGets the current memory profile for the workspace.- Returns:
- array of Strings of length 4 describing memory usage:
- [0]Used - Memory Used by the Server so far for storage
- [1]Allocated - Memory allocated for use. Often if a large data item was allocated by a server and subsequently freed, this value will be large compared to "Used". If nearly all memory allocated is in use, this value will be close to (but always higher than) "Used"
- [2]Mapped - is the space used by memory-mapped files
- [3]Available - is the total available memory for the Server process
- Throws:
ServiceException
- if any system-level error occurs
-
validateGroupMembership
@Deprecated boolean validateGroupMembership(Long[] memGroupIds_, Long[] admGroupIds_) throws InvalidAnonymousUserException, InvalidUserException Deprecated.No longer necessary with credential systemValidates if the association of a user as 'Member' and as an 'Administrator has changed or not.- Parameters:
memGroupIds_
- Groups for which the User is a memberadmGroupIds_
- Groups for which the User is an administrator- Returns:
- true if there is not change in the membership of the user
- Throws:
InvalidAnonymousUserException
- if the user calling this method is anonymous, but anonymous access has not been enabledInvalidUserException
- if the user calling this method does not existNullPointerException
- if any of the input arrays arenull
ServiceException
- if any system-level error occurs
-
updateUsernames
@Deprecated void updateUsernames(String[] oldUsernames_, String[] newUsernames_, long maxExpirationTimeInSeconds_) throws IllegalArgumentException, PrivilegeException, DuplicateNameException Deprecated.DEPRECATED: SeeUserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
Updates a list of old usernames to new usernames.If successful, this method must be followed by
commitUpdateUsernames()
. AftercommitUpdateUsernames
has been called, the old usernames will still be active, but will expire after the interval specified bymaxExpirationTimeInSeconds_
; ifupdateUsernames
is successful butcommitUpdateUsernames
is not called, the new usernames will not become active.If unsuccessful, this method should be followed by
rollbackUpdateUsernames()
. This will simply free memory dedicated to mapping old usernames to new usernames.- Parameters:
oldUsernames_
- the usernames to be updatednewUsernames_
- the usernames to which the old usernames will be updatedmaxExpirationTimeInSeconds_
- the interval, in seconds, aftercommitUpdateUsernames
has been called, after which the old usernames will expire. If this parameter is zero or a negative value the old usernames will expire instantly. After expiration, the old usernames will no longer be valid.- Throws:
IllegalArgumentException
- if the length ofoldUsernames_
is not the same as the length ofnewUsernames_
.PrivilegeException
- if the current user is not a system administratorDuplicateNameException
- if anyoldUsernames_
ornewUsernames_
contain any duplicates, or if an old username is being updated to a username that already existsServiceException
- if any system-level error occurs
-
commitUpdateUsernames
Deprecated.DEPRECATED: SeeUserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
Commits an update of usernames.This method should be preceded by a call to
updateUsernames(String[], String[], long)
. After the commit, the old usernames will be temporarily active, and will expire after the interval specified bymaxExpirationTimeInSeconds_
; ifcommitUpdateUsernames
is not called, the new usernames will not become active.- Throws:
ServiceException
- if any system-level error occurs
-
rollbackUpdateUsernames
Deprecated.DEPRECATED: SeeUserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
Rolls back an update of usernames.This method should be called if
updateUsernames(String[], String[], long)
is unsuccessful. The rollback will simply free memory dedicated to mapping old usernames to new usernames.- Throws:
ServiceException
- if any system-level error occurs
-
reloadProperties
Deprecated.reloading properties is now automatic, so this call is now unnecessary and does nothing.Reloads all database-level properties files (*.xml, *.properties) without interrupting API services- Throws:
ServiceException
- if any system-level error occurs
-
validate
Deprecated.use thevalidate
diagnostic script insteadRuns validation tests against the database to check whether it is corrupt, and returns a line-separated list of validation results- Returns:
- the validation results
- Throws:
ServiceException
- if any system-level error occurs
-
getSiteLocaleSettings
SiteLocaleSettings getSiteLocaleSettings()Deprecated.Returns the site locale settings for the administration server UseGlobalizationService.getSiteLocaleSettings()
to get site locale setting for the entire site. -
setSiteLocaleSettings
Deprecated.Registers the site local settings for the administration server. UseGlobalizationService.setSiteLocaleSettings(SiteLocaleSettings)
to register site locale setting for entire site. All the properties in theSiteLocaleSettings
parameter must be populated. The locale settings that have already been set are going to be preserved. It is required that theprimary locale
is present and enabled in the array oflocale settings
.- Throws:
PrivilegeException
- if the current user is not a portal administrator
-
getSiteTimeZoneSettings
SiteTimeZoneSettings getSiteTimeZoneSettings()Deprecated.Gets the site timezone settings for the adminstration server UseGlobalizationService.getSiteTimeZoneSettings()
to get the timezone settings of the entire site. -
setSiteTimeZoneSettings
Deprecated.Registers the site timezone settings for the administration server. UseGlobalizationService.setSiteTimeZoneSettings(SiteTimeZoneSettings)
to set the timezone settings for the entire site. -
getSiteCalendarSettings
SiteCalendarSettings getSiteCalendarSettings()Deprecated.Gets the calendar settings for the administration server UseGlobalizationService.getSiteCalendarSettings()
to get the calendar settings of the entire site. -
setSiteCalendarSettings
Deprecated.Registers the calendar setting for the administration server. UseGlobalizationService.setSiteCalendarSettings(SiteCalendarSettings)
to set the calendar settings for the entire site. -
getSystemPageId
Long getSystemPageId(@ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) String systemPageUuid) Deprecated.Gets the system page id corresponding to the given UUID. System pages UUIDs include:"SYSTEM_PAGE_PORTAL_HOME" "SYSTEM_PAGE_PORTAL_LICENSE_ADMINISTRATION" "SYSTEM_PAGE_PORTAL_SERVICES" "SYSTEM_PAGE_PORTAL_PROCESS_KOUGAR_MONITOR" "SYSTEM_PAGE_PORTAL_REAL_TIME_MONITOR" "SYSTEM_PAGE_PORTAL_START_PAGE_SETTINGS" "SYSTEM_PAGE_PORTAL_CREATE_AN_ADMIN_PAGE" "SYSTEM_PAGE_PORTAL_SET_WORKING_TIME" "SYSTEM_PAGE_PORTAL_NAVIGATION_BUTTONS" "SYSTEM_PAGE_PORTAL_DATA_TYPES" "SYSTEM_PAGE_PROCESS_MODEL_DASHBOARD" "SYSTEM_PAGE_PROCESS_DASHBOARD"
- Parameters:
systemPageUuid
- one of the UUIDs listed above
-