|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.security.provider.AuthorizationImpl
Method Summary | |
void |
addPermissions(IPermission[] permissions)
Adds IPermissions to the back end store. |
boolean |
canPrincipalPublish(IAuthorizationPrincipal principal)
This checks if the framework has granted principal a right to publish. |
boolean |
canPrincipalRender(IAuthorizationPrincipal principal,
int channelPublishId)
Answers if the principal has permission to RENDER this Channel. |
boolean |
canPrincipalSubscribe(IAuthorizationPrincipal principal,
int channelPublishId)
Answers if the principal has permission to SUBSCRIBE to this Channel. |
boolean |
doesPrincipalHavePermission(IAuthorizationPrincipal principal,
java.lang.String owner,
java.lang.String activity,
java.lang.String target)
Answers if the owner has given the principal (or any of its parents) permission to perform the activity on the target. |
boolean |
doesPrincipalHavePermission(IAuthorizationPrincipal principal,
java.lang.String owner,
java.lang.String activity,
java.lang.String target,
IPermissionPolicy policy)
Answers if the owner has given the principal permission to perform the activity on the target, as evaluated by the policy. |
IPermission[] |
getAllPermissionsForPrincipal(IAuthorizationPrincipal principal,
java.lang.String owner,
java.lang.String activity,
java.lang.String target)
Returns the IPermissions owner has granted this Principal for
the specified activity and target. |
java.util.Vector |
getAuthorizedChannels(IAuthorizationPrincipal principal)
Does this mean all channels the principal could conceivably subscribe to or all channels principal is specifically authorized to subscribe to, or what? |
IAuthorizationPrincipal[] |
getAuthorizedPrincipals(java.lang.String owner,
java.lang.String activity,
java.lang.String target)
Returns IAuthorizationPrincipals that have IPermissions for
the given owner, activity and target. |
IGroupMember |
getGroupMember(IAuthorizationPrincipal principal)
|
IPermission[] |
getPermissionsForOwner(java.lang.String owner,
java.lang.String activity,
java.lang.String target)
Returns the IPermissions owner has granted for the specified activity
and target. |
IPermission[] |
getPermissionsForPrincipal(IAuthorizationPrincipal principal,
java.lang.String owner,
java.lang.String activity,
java.lang.String target)
Returns the IPermissions owner has granted this Principal for
the specified activity and target. |
IAuthorizationPrincipal |
getPrincipal(IPermission permission)
Returns IAuthorizationPrincipal associated with the IPermission . |
java.lang.String |
getPrincipalString(IAuthorizationPrincipal principal)
Returns the String used by an IPermission to represent an
IAuthorizationPrincipal . |
IPermission[] |
getUncachedPermissionsForPrincipal(IAuthorizationPrincipal principal,
java.lang.String owner,
java.lang.String activity,
java.lang.String target)
Returns the IPermissions owner has granted this Principal for
the specified activity and target. |
IPermission |
newPermission(java.lang.String owner)
Factory method for an IPermission . |
IPermission |
newPermission(java.lang.String owner,
IAuthorizationPrincipal principal)
Factory method for an IPermission . |
IPermissionManager |
newPermissionManager(java.lang.String owner)
Factory method for IPermissionManager. |
IAuthorizationPrincipal |
newPrincipal(IGroupMember groupMember)
Converts an IGroupMember into an IAuthorizationPrincipal . |
IAuthorizationPrincipal |
newPrincipal(java.lang.String key,
java.lang.Class type)
Factory method for IAuthorizationPrincipal. |
IUpdatingPermissionManager |
newUpdatingPermissionManager(java.lang.String owner)
Factory method for IUpdatingPermissionManager. |
void |
removePermissions(IPermission[] permissions)
Removes IPermissions from the back end store. |
static IAuthorizationService |
singleton()
|
void |
updatePermissions(IPermission[] permissions)
Updates IPermissions in the back end store. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public void addPermissions(IPermission[] permissions) throws AuthorizationException
IPermissions
to the back end store.
addPermissions
in interface IAuthorizationService
permissions
- IPermission[]
AuthorizationException
public boolean canPrincipalPublish(IAuthorizationPrincipal principal) throws AuthorizationException
canPrincipalPublish
in interface IAuthorizationService
principal
- IAuthorizationPrincipal
AuthorizationException
public boolean canPrincipalRender(IAuthorizationPrincipal principal, int channelPublishId) throws AuthorizationException
canPrincipalRender
in interface IAuthorizationService
principal
- IAuthorizationPrincipalchannelPublishId
- int
AuthorizationException
- indicates authorization information could not be retrieved.public boolean canPrincipalSubscribe(IAuthorizationPrincipal principal, int channelPublishId) throws AuthorizationException
canPrincipalSubscribe
in interface IAuthorizationService
principal
- IAuthorizationPrincipalchannelPublishId
- int
AuthorizationException
- indicates authorization information could not be retrieved.public boolean doesPrincipalHavePermission(IAuthorizationPrincipal principal, java.lang.String owner, java.lang.String activity, java.lang.String target) throws AuthorizationException
owner
and
activity
must be non-null. If target
is null, then
target is not checked.
doesPrincipalHavePermission
in interface IAuthorizationService
principal
- IAuthorizationPrincipalowner
- java.lang.Stringactivity
- java.lang.Stringtarget
- java.lang.String
AuthorizationException
- indicates authorization information could not
be retrieved.public boolean doesPrincipalHavePermission(IAuthorizationPrincipal principal, java.lang.String owner, java.lang.String activity, java.lang.String target, IPermissionPolicy policy) throws AuthorizationException
policy
, owner
and activity
must be non-null.
doesPrincipalHavePermission
in interface IAuthorizationService
principal
- IAuthorizationPrincipalowner
- java.lang.Stringactivity
- java.lang.Stringtarget
- java.lang.String
AuthorizationException
- indicates authorization information could not
be retrieved.public IPermission[] getAllPermissionsForPrincipal(IAuthorizationPrincipal principal, java.lang.String owner, java.lang.String activity, java.lang.String target) throws AuthorizationException
IPermissions
owner has granted this Principal
for
the specified activity and target. Null parameters will be ignored, that is, all
IPermissions
matching the non-null parameters are retrieved. So,
getPermissions(principal,null, null, null)
should retrieve all IPermissions
for a Principal
. Note that this includes IPermissions
inherited
from groups the Principal
belongs to.
getAllPermissionsForPrincipal
in interface IAuthorizationService
principal
- IAuthorizationPrincipalowner
- java.lang.Stringactivity
- java.lang.Stringtarget
- java.lang.String
AuthorizationException
- indicates authorization information could not
be retrieved.public java.util.Vector getAuthorizedChannels(IAuthorizationPrincipal principal) throws AuthorizationException
getAuthorizedChannels
in interface IAuthorizationService
principal
- IAuthorizationPrincipal
AuthorizationException
- indicates authorization information could notpublic IAuthorizationPrincipal[] getAuthorizedPrincipals(java.lang.String owner, java.lang.String activity, java.lang.String target) throws AuthorizationException
IAuthorizationPrincipals
that have IPermissions
for
the given owner, activity and target.
owner
- activity
- target
-
AuthorizationException
public IGroupMember getGroupMember(IAuthorizationPrincipal principal) throws GroupsException
getGroupMember
in interface IAuthorizationService
principal
- org.jasig.portal.security.IAuthorizationPrincipal
GroupsException
public IPermission[] getPermissionsForOwner(java.lang.String owner, java.lang.String activity, java.lang.String target) throws AuthorizationException
IPermissions
owner has granted for the specified activity
and target. Null parameters will be ignored, that is, all IPermissions
matching the non-null parameters are retrieved.
getPermissionsForOwner
in interface IAuthorizationService
owner
- java.lang.Stringactivity
- java.lang.Stringtarget
- java.lang.String
AuthorizationException
- indicates authorization information could not
be retrieved.public IPermission[] getPermissionsForPrincipal(IAuthorizationPrincipal principal, java.lang.String owner, java.lang.String activity, java.lang.String target) throws AuthorizationException
IPermissions
owner has granted this Principal
for
the specified activity and target. Null parameters will be ignored, that is, all
IPermissions
matching the non-null parameters are retrieved. So,
getPermissions(principal,null, null, null)
should retrieve all IPermissions
for a Principal
.
getPermissionsForPrincipal
in interface IAuthorizationService
principal
- IAuthorizationPrincipalowner
- java.lang.Stringactivity
- java.lang.Stringtarget
- java.lang.String
AuthorizationException
- indicates authorization information could not
be retrieved.public IAuthorizationPrincipal getPrincipal(IPermission permission) throws AuthorizationException
IAuthorizationPrincipal
associated with the IPermission
.
getPrincipal
in interface IAuthorizationService
permission
- IPermission
AuthorizationException
public java.lang.String getPrincipalString(IAuthorizationPrincipal principal)
IPermission
to represent an
IAuthorizationPrincipal
.
getPrincipalString
in interface IAuthorizationService
principal
- org.jasig.portal.security.IAuthorizationPrincipalpublic IPermission[] getUncachedPermissionsForPrincipal(IAuthorizationPrincipal principal, java.lang.String owner, java.lang.String activity, java.lang.String target) throws AuthorizationException
IPermissions
owner has granted this Principal
for
the specified activity and target. Null parameters will be ignored, that is, all
IPermissions
matching the non-null parameters are retrieved. So,
getPermissions(principal,null, null, null)
should retrieve all IPermissions
for a Principal
. Ignore any cached IPermissions
.
principal
- IAuthorizationPrincipalowner
- java.lang.Stringactivity
- java.lang.Stringtarget
- java.lang.String
AuthorizationException
- indicates authorization information could not
be retrieved.public IPermission newPermission(java.lang.String owner)
IPermission
.
owner
- String
public IPermission newPermission(java.lang.String owner, IAuthorizationPrincipal principal)
IPermission
.
newPermission
in interface IAuthorizationService
owner
- Stringprincipal
- IAuthorizationPrincipal
public IPermissionManager newPermissionManager(java.lang.String owner)
newPermissionManager
in interface IAuthorizationService
owner
- java.lang.String
public IAuthorizationPrincipal newPrincipal(java.lang.String key, java.lang.Class type)
newPrincipal
in interface IAuthorizationService
key
- java.lang.Stringtype
- java.lang.Class
public IAuthorizationPrincipal newPrincipal(IGroupMember groupMember) throws GroupsException
IGroupMember
into an IAuthorizationPrincipal
.
newPrincipal
in interface IAuthorizationService
groupMember
- org.jasig.portal.groups.IGroupMember
GroupsException
public IUpdatingPermissionManager newUpdatingPermissionManager(java.lang.String owner)
newUpdatingPermissionManager
in interface IAuthorizationService
owner
- java.lang.String
public void removePermissions(IPermission[] permissions) throws AuthorizationException
IPermissions
from the back end store.
removePermissions
in interface IAuthorizationService
permissions
- IPermission[]
AuthorizationException
public static IAuthorizationService singleton() throws AuthorizationException
AuthorizationException
public void updatePermissions(IPermission[] permissions) throws AuthorizationException
IPermissions
in the back end store.
updatePermissions
in interface IAuthorizationService
permissions
- IPermission[]
AuthorizationException
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |