|
Foundation |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MetadataServerInterface
Field Summary |
---|
Fields inherited from interface com.sas.services.information.ServerInterface |
---|
DEFAULT_SERVER_NAME, SERVER_VERSION_913_SP3, SERVER_VERSION_913_SP4, SERVER_VERSION_920, SERVER_VERSION_930, SERVER_VERSION_UNKNOWN |
Method Summary | |
---|---|
void |
applyACTToObj(java.lang.String resource,
java.lang.String act)
Apply an AccessControlTemplate to a metadata object. |
void |
createAccessControTemplate(RepositoryInterface repository,
ACTEntry act)
Create a new AccessControlTemplate in this repository. |
com.sas.metadata.remote.Root |
createMetadata(java.lang.String repositoryId,
java.lang.String name,
java.lang.String type)
Create a new metadata object. |
void |
deleteEntities(java.util.List metadataObjects)
Delete a collection of CMetadata objects. |
void |
deleteEntity(com.sas.metadata.remote.CMetadata metadata)
Allow a CMetadata object to be passed in to be deleted. |
void |
deleteInternalPassword(java.lang.String username)
Delete a user's internal password. |
void |
destroyAccessControlTemplate(java.lang.String act)
Destroy an AccessControlTemplate in the repository. |
void |
freeCredentials(java.lang.String credential)
Free a credential handle. |
ACTEntry |
getAccessControlTemplateAttribs(java.lang.String act)
Get attributes for an AccessControlTemplate. |
java.util.List |
getAccessControlTemplateList(RepositoryInterface repository,
int flags)
Get the list of AccessControlTemplates for this repository. |
java.util.List |
getACTsOnObj(java.lang.String resource)
Get the AccessControlTemplates that are associated to an object. |
java.util.List |
getApplicationActionsAuthorizations(SoftwareComponentInterface app)
Get the authorizations on an application's actions. |
java.util.List |
getApplicationActionsAuthorizations(SoftwareComponentInterface app,
RoleInterface role,
boolean explicitRoleActions)
Get the authorizations on an application's actions. |
java.lang.String[][] |
getAuthorizations(java.lang.String authType,
java.lang.String credHandle,
java.lang.String resource,
java.lang.String permission)
Get the authorization information for a metadata resource. |
java.util.List<AuthorizationObjectsResult> |
getAuthorizationsForObjects(java.util.List<MetadataInterface> resources,
java.util.List<java.lang.String> permissions)
Get authorization information for a list of metadata objects. |
java.util.List |
getAuthorizationsOnObj(java.lang.String resource,
java.util.List identities,
java.util.List permissions,
int flags)
Get the authorizations on an object for the given identities and permissions. |
int |
getCountNoSecurity(Filter filter,
java.lang.String association)
Perform a search operation against the metadata repository which will return a count of the matching objects, rather than the objects themselves. |
java.util.Date |
getCreateDate(MetadataInterface mi)
Get the Created date of a metadata object as a Date rather than a String. |
java.lang.String |
getCredentials(java.lang.String subject)
See the ISecurity interface documentation for a description of this method. |
java.util.Map |
getEnterprisePolicies()
Get a Map with the server-managed enterprise policies. |
java.util.List |
getIdentitiesOnObj(java.lang.String resource,
int flags)
Get a List of identities associated with an object through authorizations. |
IdentityInfo |
getIdentityInfo()
Return an IdentityInfo object containing information about the currently connected user. |
java.lang.String |
getInternalDomain()
Return the string that represents the internal authentication domain. |
InternalLoginSitePolicies |
getInternalLoginSitePolicies()
Get the site policies that control the internal authentication provider. |
InternalLoginUserInfo |
getInternalLoginUserInfo(java.lang.String username)
Get the information regarding a user's internal login. |
java.util.List |
getLoginsForAuthDomain(java.lang.String domain)
Get the logins for the connected user for a given authentication domain. |
java.util.Date |
getModifiedDate(MetadataInterface mi)
Get the modified date of a metadata object as a Date rather than a String. |
java.util.Map |
getTypeDictionaryMap()
Get the Map of TypeDescriptors. |
AuthResult |
isAuthorizedWithConditions(java.lang.String credential,
java.lang.String resource,
java.lang.String permission)
Check authorization status for a given credential, resource, and permission. |
void |
removeACTFromObj(java.lang.String resource,
java.lang.String act)
Remove an AccessControlTemplate from a metadata object. |
void |
setAccessControlTemplateAttribs(RepositoryInterface repository,
ACTEntry act)
Set attributes on an AccessControlTemplate. |
void |
setAuthorizationsOnObj(java.lang.String resource,
java.util.List authorizations,
int flags)
Set authorizations on a metadata object. |
void |
setInternalLoginUserOptions(java.lang.String username,
boolean isDisabled,
boolean bypassStrength,
boolean bypassHistory,
boolean useStdPasswordExpirationDays,
int passwordExpirationDays,
boolean bypassLockout,
boolean bypassInactivitySuspension,
boolean expireAccount,
java.util.Date accountExpirationDate)
Set the options on a user's internal login. |
void |
setInternalPassword(java.lang.String username,
java.lang.String password)
Set a user's internal password. |
Methods inherited from interface com.sas.services.information.ServerInterface |
---|
addToCache, browseFetch, browseFolder, browseFolderRecursive, browseSearch, browseSearch, browseSearch, browseSearch, clearPendingChanges, connect, connect, debug, debug, debug, deleteEntity, destroy, error, error, executeRequest, factoryProcess, fetch, fetch, flush, fromByteArray, generatePassword, getDomain, getExplicitIdentityGroup, getFoundationRepository, getHomeFolder, getHomeFolder, getHost, getIdentity, getName, getObjectByPath, getObjectByPathFilter, getPerson, getPort, getProtocol, getRepositories, getRepositories, getRepository, getRepositoryInfo, getRepositoryName, getRepositoryNames, getRootFolder, getServerVersion, getTypeDescriptor, getUserContext, info, info, info, isAuthorized, isUserAuthorized, loadTypes, loadTypes, newChild, newChild, newMetadata, reconnect, refreshAllData, refreshEntity, search, search, search, toByteArray, warn, warn, warn |
Method Detail |
---|
java.util.List getLoginsForAuthDomain(java.lang.String domain) throws ServiceException, java.rmi.RemoteException
domain
- The authentication domain to return the logins for.
UserIdentityInterface
objects accessible by the connected user in the requested domain.
ServiceException
- If a service-level error occurs.
java.rmi.RemoteException
- In teh event of remote object failure.java.util.List getApplicationActionsAuthorizations(SoftwareComponentInterface app, RoleInterface role, boolean explicitRoleActions) throws ServiceException, java.rmi.RemoteException
app
- The SoftwareComponent that represents the application to check.role
- The Role for which ApplicationActions Authorizations will be returnedexplicitRoleActions
- Limit the returned ApplicationsActions to the indicated Role
only. ApplicationsActions from contributed Roles will not be returned.
ApplicationAuthorization
objects
which indicate the list of actions available for the application and for each, whether
the current user is allowed access to that action.
ServiceException
- If a server error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.util.List getApplicationActionsAuthorizations(SoftwareComponentInterface app) throws ServiceException, java.rmi.RemoteException
app
- The SoftwareComponent that represents the application to check.
ApplicationAuthorization
objects
which indicate the list of actions available for the application and for each, whether
the current user is allowed access to that action.
ServiceException
- If a server error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.util.Map getEnterprisePolicies() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a server error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.lang.String getCredentials(java.lang.String subject) throws ServiceException, java.rmi.RemoteException
subject
- The subject for which to get a credential handle.
ServiceException
- in the event of repository errors.
java.rmi.RemoteException
- in the event of remote object failure.void freeCredentials(java.lang.String credential) throws ServiceException, java.rmi.RemoteException
credential
- The credential to free.
ServiceException
- in the event of repository errors.
java.rmi.RemoteException
- in the event of remote object failure.AuthResult isAuthorizedWithConditions(java.lang.String credential, java.lang.String resource, java.lang.String permission) throws ServiceException, java.rmi.RemoteException
credential
- A credential handle. If this is null, the current
authenticated user is checked for permission.resource
- A resource string of the form OMSOBJ:type/FQID which represents
the object whose permissions are being checked.permission
- A permission or comma-separated list of permissions to check
against the user's authorized permissions for the resource.
ServiceException
- in the event of repository errors.
java.rmi.RemoteException
- in the event of remote object failure.java.lang.String[][] getAuthorizations(java.lang.String authType, java.lang.String credHandle, java.lang.String resource, java.lang.String permission) throws ServiceException, java.rmi.RemoteException
authType
- The type of authorization check to perform.credHandle
- A credential handle. If null, the current user's authorizations
for the resource are checked.resource
- A string of the form OMSOBJ:type/FQID representing the metadata
object to be checked.permission
- A permission string, or a comma-separated list of permissions
to check.
ServiceException
- in the event of repository errors.
java.rmi.RemoteException
- in the event of remote object failure.int getCountNoSecurity(Filter filter, java.lang.String association) throws ServiceException, java.rmi.RemoteException
filter
- A Filter specifying the selection criteria as well as any
template that's desired for the operation. If the search
should be constrained to a single repository, the repository
should be set on the filter using the setOMRRepository method.
If no repository is set on the Filter, all repositories
in the server will be searched.association
- An optional parameter that requests that a specific
association be counted rather than the top level objects. If
this is used, only one top level object can be returned by the
filter, and a template must be supplied to return the
association to count.
ServiceException
- In the event of a server error.
java.rmi.RemoteException
- In the event of remote object failure.java.util.List getAuthorizationsOnObj(java.lang.String resource, java.util.List identities, java.util.List permissions, int flags) throws ServiceException, java.rmi.RemoteException
resource
- The resource string of the object to test. A resource string should
be of the form OMSOBJ:obj_type/obj_ID (e.g., OMSOBJ:PhysicalTable/A5DRX6L4.AJ00001Z).identities
- A List of IdentityInterface
objects for the users to test permissions for. If left null, all identities are returned.permissions
- A List of Permission
objects specifying
the permissions to check. If null, all permissions for all specified identities on the object are
returned.flags
- Flags which control the return values. Valid flags are:
ISecurityAdmin.SECAD_ACT_CONTENTS and ISecurityAdmin.SECAD_DO_NOT_RETURN_PERMCOND. See the
documentation for ISecurityAdmin.GetAuthorizationsOnObj for more details.
Authorization
objects with the resulting authorization data.
ServiceException
- if a service level error occurs.
java.rmi.RemoteException
- in the event of remote object failure.void setAuthorizationsOnObj(java.lang.String resource, java.util.List authorizations, int flags) throws ServiceException, java.rmi.RemoteException
resource
- The resource string of the object to test. A resource string should
be of the form OMSOBJ:obj_type/obj_ID (e.g., OMSOBJ:PhysicalTable/A5DRX6L4.AJ00001Z).authorizations
- A List of Authorization
objects defining the authorizations to set on the object.flags
- Controls the behavior of the method. The only valid flag as of this
writing is ISecurityAdmin.SECAD_ACT_CONTENTS. Check the documentation for the
ISecurityAdmin interface for details.
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.util.List<AuthorizationObjectsResult> getAuthorizationsForObjects(java.util.List<MetadataInterface> resources, java.util.List<java.lang.String> permissions) throws ServiceException, java.rmi.RemoteException
resources
- A List of MetadataInterface objects to check authorizations for.permissions
- A List of permission strings to check the metadata objects
for.
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.util.List getIdentitiesOnObj(java.lang.String resource, int flags) throws ServiceException, java.rmi.RemoteException
resource
- The resource string of the object to test. A resource string should
be of the form OMSOBJ:obj_type/obj_ID (e.g., OMSOBJ:PhysicalTable/A5DRX6L4.AJ00001Z).flags
- Zero or ISecurityAdmin.SECAD_ACT_CONTENTS. See the javadoc for
ISecurityAdmin for more information.
examples:
Person/Gary Williams
IdentityGroup/PUBLIC
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.util.List getACTsOnObj(java.lang.String resource) throws ServiceException, java.rmi.RemoteException
resource
- The resource string of the object to test. A resource string should
be of the form OMSOBJ:obj_type/obj_ID (e.g., OMSOBJ:PhysicalTable/A5DRX6L4.AJ00001Z).
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of a remote object failure.void applyACTToObj(java.lang.String resource, java.lang.String act) throws ServiceException, java.rmi.RemoteException
resource
- The resource string of the object to test. A resource string should
be of the form OMSOBJ:obj_type/obj_ID (e.g., OMSOBJ:PhysicalTable/A5DRX6L4.AJ00001Z).act
- The resource string representing the AccessControlTemplate. It's the same
format as the resource parameter.
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of a remote object failure.void removeACTFromObj(java.lang.String resource, java.lang.String act) throws ServiceException, java.rmi.RemoteException
resource
- The resource string of the object to modify. A resource string should
be of the form OMSOBJ:obj_type/obj_ID (e.g., OMSOBJ:PhysicalTable/A5DRX6L4.AJ00001Z).act
- The resource string representing the AccessControlTemplate. It's the same
format as the resource parameter.
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of a remote object failure.java.util.List getAccessControlTemplateList(RepositoryInterface repository, int flags) throws ServiceException, java.rmi.RemoteException
repository
- The repository to retrieve the Access Control Templates for.flags
- zero or ISecurityAdmin.SECAD_REPOSITORY_DEPENDENCY_USES to
get AccessControlTemplates for repositories up the dependency chain from
this one.
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.void createAccessControTemplate(RepositoryInterface repository, ACTEntry act) throws ServiceException, java.rmi.RemoteException
repository
- The repository to create tne new Access Control Template in.act
- An ACTEntry describing the new entry. The name must be
set. The description may be set, and the use parameter should be
left null, or set to "REPOS" if this is to become the new repository
default ACT (if you have permission to perform that operation).
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.void destroyAccessControlTemplate(java.lang.String act) throws ServiceException, java.rmi.RemoteException
act
- The resource ID of the ACT. A resource string should
be of the form OMSOBJ:obj_type/obj_ID (e.g., OMSOBJ:AccessControlTemplate/A5DRX6L4.AJ00001Z).
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.void setAccessControlTemplateAttribs(RepositoryInterface repository, ACTEntry act) throws ServiceException, java.rmi.RemoteException
repository
- The repository containing the ACT to update.act
- An ACTEntry object with the new information about the ACT.
Set the use parameter in the ACTEntry to "REPOS" to make it the repository
default, and be sure you have the necessary permissions to do it or expect
an exception.
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.ACTEntry getAccessControlTemplateAttribs(java.lang.String act) throws ServiceException, java.rmi.RemoteException
act
- The resource ID of the ACT. A resource string should
be of the form OMSOBJ:obj_type/obj_ID (e.g., OMSOBJ:AccessControlTemplate/A5DRX6L4.AJ00001Z).
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.void setInternalPassword(java.lang.String username, java.lang.String password) throws ServiceException, java.rmi.RemoteException
username
- The name of the user to set an internal password for. This
is the Name attribute on a Person object.password
- The password to set for internal authentication.
ServiceException
- If a server error occurs.
java.rmi.RemoteException
- In the event of remote object failure.void deleteInternalPassword(java.lang.String username) throws ServiceException, java.rmi.RemoteException
username
- The name of the user whose internal password should
be deleted.
ServiceException
- If a server error occurs.
java.rmi.RemoteException
- In the event of remote object failure.InternalLoginSitePolicies getInternalLoginSitePolicies() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a server error occurs.
java.rmi.RemoteException
- In the event of remote object failure.InternalLoginUserInfo getInternalLoginUserInfo(java.lang.String username) throws ServiceException, java.rmi.RemoteException
username
- The user to retrieve internal login parameters for.
ServiceException
- If a server error occurs.
java.rmi.RemoteException
- In the event of remote object failure.void setInternalLoginUserOptions(java.lang.String username, boolean isDisabled, boolean bypassStrength, boolean bypassHistory, boolean useStdPasswordExpirationDays, int passwordExpirationDays, boolean bypassLockout, boolean bypassInactivitySuspension, boolean expireAccount, java.util.Date accountExpirationDate) throws ServiceException, java.rmi.RemoteException
username
- The user whose internal login data is to be updated.isDisabled
- A flag indicating if the internal login is disabled.bypassStrength
- Bypass the site password strength requirements.bypassHistory
- Bypass the site password history checks.useStdPasswordExpirationDays
- Use the site password expiration setting.passwordExpirationDays
- Override setting in days for password expiration.bypassLockout
- Bypass the site policy for account lockout.bypassInactivitySuspension
- Bypass the site policy for inactivity suspension.expireAccount
- Set the flag indicating whether this account ever expires.accountExpirationDate
- Set the date that this account expires.
ServiceException
- If a server error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.util.Date getCreateDate(MetadataInterface mi) throws ServiceException, java.rmi.RemoteException
mi
- The metadata object to get the create date for.
ServiceException
- If a repository error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.util.Date getModifiedDate(MetadataInterface mi) throws ServiceException, java.rmi.RemoteException
mi
- The metadata object to get the modified date for.
ServiceException
- If a repository error occurs.
java.rmi.RemoteException
- In the event of remote object failure.void deleteEntity(com.sas.metadata.remote.CMetadata metadata) throws ServiceException, java.rmi.RemoteException
metadata
- The CMetadata object to be deleted.
ServiceException
- in the event of back end repository failure.
java.rmi.RemoteException
- in the event of remote object failure.void deleteEntities(java.util.List metadataObjects) throws ServiceException, java.rmi.RemoteException
metadataObjects
- a List of CMetadata objects to be deleted.
ServiceException
- in the event of back end repository failure.
java.rmi.RemoteException
- in the event of remote object failure.com.sas.metadata.remote.Root createMetadata(java.lang.String repositoryId, java.lang.String name, java.lang.String type) throws java.rmi.RemoteException, ServiceException
repositoryId
- The FQID of the repository where the object is
to be created.name
- A String for the name of the new object.type
- The Type for the new object. Should be a field from
MetadataObjects.
java.rmi.RemoteException
- In the event of remote object failure.
ServiceException
- If a repository error occurs.java.util.Map getTypeDictionaryMap() throws ServiceException, java.rmi.RemoteException
com.sas.services.information.publicObject.TypeDescriptorInterface
objects.
ServiceException
- If a service level error occurs.
java.rmi.RemoteException
- In the event of remote object failure.java.lang.String getInternalDomain() throws ServiceException, java.rmi.RemoteException
ServiceException
- In the event of a service error.
java.rmi.RemoteException
- In the event of remote object failure.IdentityInfo getIdentityInfo() throws ServiceException, java.rmi.RemoteException
ServiceException
- If a metadata server error occurs.
java.rmi.RemoteException
- In the event of remote object failure.
|
Foundation |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |