|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
IAuthorizationService
represents the portal's authorization service.
All requests for authorization activities ultimately come here.Method Summary | |
void |
addPermissions(IPermission[] permissions)
Adds IPermissions to the service. |
boolean |
canPrincipalPublish(IAuthorizationPrincipal principal)
I'm not sure what this means (Dan). |
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 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? |
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 the IAuthorizationPrincipal associated with the IPermission . |
java.lang.String |
getPrincipalString(IAuthorizationPrincipal principal)
Returns a String used to represent the IAuthorizationPrincipal . |
IPermission |
newPermission(java.lang.String owner,
IAuthorizationPrincipal principal)
Creates a new IPermission for the principal on behalf of the
owner . |
IPermissionManager |
newPermissionManager(java.lang.String key)
|
IAuthorizationPrincipal |
newPrincipal(IGroupMember groupMember)
Converts an IGroupMember into an IAuthorizationPrincipal . |
IAuthorizationPrincipal |
newPrincipal(java.lang.String key,
java.lang.Class type)
Factory method for an IAuthorizationPrincipal . |
IUpdatingPermissionManager |
newUpdatingPermissionManager(java.lang.String key)
|
void |
removePermissions(IPermission[] permissions)
Removes IPermissions from the service. |
void |
updatePermissions(IPermission[] permissions)
Updates IPermissions in the service. |
Method Detail |
public void addPermissions(IPermission[] permissions) throws AuthorizationException
IPermissions
to the service.
permissions
- IPermission[]
AuthorizationException
public boolean canPrincipalPublish(IAuthorizationPrincipal principal) throws AuthorizationException
principal
- IAuthorizationPrincipal
AuthorizationException
public boolean canPrincipalRender(IAuthorizationPrincipal principal, int channelPublishId) throws AuthorizationException
principal
- IAuthorizationPrincipalchannelPublishId
- int
AuthorizationException
- indicates authorization information could not be retrieved.public boolean canPrincipalSubscribe(IAuthorizationPrincipal principal, int channelPublishId) throws AuthorizationException
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.
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. This includes inherited IPermissions
.
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
.
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
principal
- IAuthorizationPrincipal
AuthorizationException
- indicates authorization information could notpublic IGroupMember getGroupMember(IAuthorizationPrincipal principal) throws GroupsException
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.
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
.
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, IAuthorizationPrincipal principal) throws AuthorizationException
IPermission
for the principal
on behalf of the
owner
.
owner
- Stringprincipal
- IAuthorizationPrincipal
AuthorizationException
public IPermissionManager newPermissionManager(java.lang.String key) throws AuthorizationException
key
- java.lang.String
AuthorizationException
public IAuthorizationPrincipal newPrincipal(java.lang.String key, java.lang.Class type)
IAuthorizationPrincipal
. This type wraps an underlying
entity so that the authorization system can treat all principals alike.
key
- Stringtype
- Class
public IAuthorizationPrincipal newPrincipal(IGroupMember groupMember) throws GroupsException
IGroupMember
into an IAuthorizationPrincipal
.
groupMember
- org.jasig.portal.groups.IGroupMember
GroupsException
public IUpdatingPermissionManager newUpdatingPermissionManager(java.lang.String key) throws AuthorizationException
key
- java.lang.String
AuthorizationException
public void removePermissions(IPermission[] permissions) throws AuthorizationException
IPermissions
from the service.
permissions
- IPermission[]
AuthorizationException
public void updatePermissions(IPermission[] permissions) throws AuthorizationException
IPermissions
in the service.
permissions
- IPermission[]
AuthorizationException
public IAuthorizationPrincipal getPrincipal(IPermission permission) throws AuthorizationException
IAuthorizationPrincipal
associated with the IPermission
.
permission
- IPermission
AuthorizationException
public java.lang.String getPrincipalString(IAuthorizationPrincipal principal)
String
used to represent the IAuthorizationPrincipal
.
principal
- IAuthorizationPrincipalpublic 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. If target
is null, then
target is not checked.
principal
- IAuthorizationPrincipalowner
- java.lang.Stringactivity
- java.lang.Stringtarget
- java.lang.String
AuthorizationException
- indicates authorization information could not
be retrieved.
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |