com.webmethods.caf.portalclient.access.access
Interface IaccessPortType


public interface IaccessPortType

Web service interface to the access bizpolicy commands related to access queries and configuration


Method Summary
 Integer getaccess(URI itemID, URI userID)
          Get the principal's access rights to a MWS thing
 String getauthscheme(URI thingID)
          Get the default authentication scheme identifier for a MWS thing
 URI getsecurityrealm(URI thingID)
          Get the URI of the security realm that is controlling access to a MWS thing
 Boolean isanonymous(URI thingID)
          Determine if a MWS thing can be accessed anonymously
 void removeaces(Object[] principalIds, boolean recursive, URI resourceURI)
          Remove any Access Control Entries on a MWS thing for a specified principal.
 void removesecurityrealm(URI itemID, boolean recursive, URI securityRealmID)
          Remove a MWS thing from the list of resources controlled by a specific security realm
 void setaces(int delegate, int deny, int exclusive, int grant, int mask, Object[] principalIds, boolean recursive, URI thingID)
          Set the Access Control Entries (ACE) for a specific MWS thing for a list of users, groups, or roles (principals) on a specific MWS thing
 void setanonymous(boolean anonymous, boolean recursive, URI thingID)
          Set whether a MWS thing can be accessed anonymously
 void setauthscheme(String authScheme, boolean recursive, URI thingID)
          Set the default authentication scheme for a MWS thing.
 void setsecurityrealm(URI itemID, boolean recursive, URI securityRealmID)
          Set the security realm to control access to a MWS thing
 

Method Detail

setaces

void setaces(int delegate,
             int deny,
             int exclusive,
             int grant,
             int mask,
             Object[] principalIds,
             boolean recursive,
             URI thingID)
Set the Access Control Entries (ACE) for a specific MWS thing for a list of users, groups, or roles (principals) on a specific MWS thing

Parameters:
delegate - the bit-field of delegated rights for the specified princpials. See PCAccessHelper for bit-field constants.
deny - the bit-field of rights to explicitly deny to the specified principals. See PCAccessHelper for bit-field constants.
exclusive - unused bit-field
grant - the bit-field of rights to explicitly grant to the specified principals. See PCAccessHelper for bit-field constants.
mask - unused bit-field
principalIds - Array of principal URIs to add or modify access rights to the specified MWS thing
recursive - true if the access modification should be applied to this item's descendants
thingID - the MWS thing to modify access for

getaccess

Integer getaccess(URI itemID,
                  URI userID)
Get the principal's access rights to a MWS thing

Parameters:
itemID - the MWS thing to get access right to
userID - the principal to get access rights for
Returns:
a bit-field of rights that the principal to access the MWS thing. See PCAccessHelper for bit-field constants.

removeaces

void removeaces(Object[] principalIds,
                boolean recursive,
                URI resourceURI)
Remove any Access Control Entries on a MWS thing for a specified principal.

Parameters:
principalIds - Array of principal URIs to add or modify access rights to the specified MWS thing
recursive - True if the access modification should be applied to this item's descendants
resourceURI - the MWS thing whose access to modify

isanonymous

Boolean isanonymous(URI thingID)
Determine if a MWS thing can be accessed anonymously

Parameters:
thingID - the MWS thing to check for anonymous access
Returns:
true if the MWS thing can be accessed anonymously

setanonymous

void setanonymous(boolean anonymous,
                  boolean recursive,
                  URI thingID)
Set whether a MWS thing can be accessed anonymously

Parameters:
anonymous - true to allow anonymous access, false to deny anonymous access
recursive - true if the access modification should be applied to this item's descendants
thingID - the MWS thing to check for anonymous access

setauthscheme

void setauthscheme(String authScheme,
                   boolean recursive,
                   URI thingID)
Set the default authentication scheme for a MWS thing.

Parameters:
authScheme - the auth scheme identifier to apply to the MWS thing
recursive - true if the access modification should be applied to this item's descendants
thingID - the MWS thing to set the authentication scheme for

getauthscheme

String getauthscheme(URI thingID)
Get the default authentication scheme identifier for a MWS thing

Parameters:
thingID - the MWS thing to retrieve the authentication scheme for
Returns:
the identifier of the default authentication scheme for this MWS thing

getsecurityrealm

URI getsecurityrealm(URI thingID)
Get the URI of the security realm that is controlling access to a MWS thing

Parameters:
thingID - the MWS thing to retrieve the security realm for
Returns:
the URI of the security realm controlling this MWS thing. May be null.

setsecurityrealm

void setsecurityrealm(URI itemID,
                      boolean recursive,
                      URI securityRealmID)
Set the security realm to control access to a MWS thing

Parameters:
itemID - the MWS thing ID to be controlled by the security realm
recursive - true to have the security realm control the descendents of this MWS thing
securityRealmID - the MWS thing ID of the security realm

removesecurityrealm

void removesecurityrealm(URI itemID,
                         boolean recursive,
                         URI securityRealmID)
Remove a MWS thing from the list of resources controlled by a specific security realm

Parameters:
itemID - the MWS thing to be removed from the security realm
recursive - true to remove the MWS thing's descendants from the realm
securityRealmID - the MWS thing ID of the security realm