oracle.odi.domain.security

Interface IOdiRoleEnterprisePrincipalMappingService

public interface IOdiRoleEnterprisePrincipalMappingService

This service is used to map Odi Role with external Enterprise Principal (role or user)

Typical usage:

new TransactionTemplate(odiInstance.getTransactionManager()).execute(new ITransactionCallback()
                {
                        public Object doInTransaction(ITransactionStatus pStatus)
                        {
                                OdiRole trRole = ....;
                                IOdiRoleEnterprisePrincipalMappingService service = new OdiRoleEnterprisePrincipalMappingServiceImpl(getOdiInstance());
                                service.mapEnterprisePrincipalMember(trRole, "enterprisePrincipalUserName", PrincipalType.ENTERPRISE_USER);
                                return null;
                        }
                });
 

Since:

12.1.2

Version:

$Header: odi/src/javadev/odi.core/src/oracle/odi/domain/security/IOdiRoleEnterprisePrincipalMappingService.java /main/1 2012/03/27 02:59:19 aputseye Exp $

See Also:

OdiRoleEnterprisePrincipalMappingServiceImpl, OdiRole

Method Summary

Modifier and Type	Method and Description
void	mapEnterprisePrincipalMember(OdiRole role, OdiEnterprisePrincipal principal) Map OdiRole and OdiEnterprisePrincipal with name principalName.
void	mapEnterprisePrincipalMember(OdiRole role, java.lang.String principalName, OdiEnterprisePrincipal.PrincipalType principalType) Map OdiRole and enterprise principal with name principalName.
void	unmapEnterprisePrincipalMember(OdiRole role, OdiEnterprisePrincipal principal) Unmap OdiRole and OdiEnterprisePrincipal with name principalName.
void	unmapEnterprisePrincipalMember(OdiRole role, java.lang.String principalName) Unmap OdiRole and enterprise principal with name principalName.

Method Detail

mapEnterprisePrincipalMember

void mapEnterprisePrincipalMember(OdiRole role,
                                  java.lang.String principalName,
                                  OdiEnterprisePrincipal.PrincipalType principalType)
                           throws EnterpriseUserOrRoleDoesNotExistException,
                                  InvalidExternalAuthenticationConfigurationException

Map OdiRole and enterprise principal with name principalName. If OdiEnterprisePrincipal with name principalName doesn't exist, it will be created.

Parameters:

role - OdiRole to map. Could not be null.

principalName - name of enterprise user or role from LDAP server.

Throws:

EnterpriseUserOrRoleDoesNotExistException - if enterprise role or user could not be found.

InvalidExternalAuthenticationConfigurationException - if there is any security exception occurs.

mapEnterprisePrincipalMember

void mapEnterprisePrincipalMember(OdiRole role,
                                  OdiEnterprisePrincipal principal)

Map OdiRole and OdiEnterprisePrincipal with name principalName. If OdiEnterprisePrincipal with name principalName doesn't exist, it will be created.

unmapEnterprisePrincipalMember

void unmapEnterprisePrincipalMember(OdiRole role,
                                    java.lang.String principalName)

Unmap OdiRole and enterprise principal with name principalName. Also if there is no other mappings enterprise principal will be removed

Throws:

EnterprisePrincipalIsNotRoleMemberException - if role isn't mapped to this principal

unmapEnterprisePrincipalMember

void unmapEnterprisePrincipalMember(OdiRole role,
                                    OdiEnterprisePrincipal principal)
                             throws EnterprisePrincipalIsNotRoleMemberException

Unmap OdiRole and OdiEnterprisePrincipal with name principalName. Also if there is no other mappings enterprise principal will be removed

Throws:

EnterprisePrincipalIsNotRoleMemberException - if role isn't mapped to this principal