com.ibm.commerce.giftcenter.facade.server.authorization

Class GiftListTypeProtectableProxy

  • java.lang.Object
    • com.ibm.commerce.security.AbstractProtectableProxy
      • com.ibm.commerce.giftcenter.facade.server.authorization.GiftListTypeProtectableProxy
  • All Implemented Interfaces:
    Groupable, Protectable


    public class GiftListTypeProtectableProxy
    extends com.ibm.commerce.security.AbstractProtectableProxy
    implements Protectable, Groupable
    This class represents a protectable proxy object that is the bridge between any Java object and the policy manager access control engine that is part of WebSphere Commerce.
    • Constructor Summary

      Constructors 
      Constructor and Description
      GiftListTypeProtectableProxy()
      Creates an instance of the protectable proxy object.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean fulfills(java.lang.Long member, java.lang.String relationship)
      This method determines if a given member fulfills a given relationship with the resource.
      java.lang.Object getGroupingAttributeValue(java.lang.String attributeName, GroupingContext context)
      Returns the value of the specified attribute.
      java.lang.Long getOwner()
      This method will return the owner of the protectable object.
      • Methods inherited from class com.ibm.commerce.security.AbstractProtectableProxy

        getActionCode, getCommandContext, getObject, getResources, setActionCode, setCommandContext, setObject, setOwner
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
      • ACCESS_CONTROL_RELATION_TYPE_REGISTRANT

        public static final java.lang.String ACCESS_CONTROL_RELATION_TYPE_REGISTRANT
        Constant for registrant access control relation.
        See Also:
        Constant Field Values
      • ACCESS_CONTROL_RELATION_TYPE_COREGISTRANT

        public static final java.lang.String ACCESS_CONTROL_RELATION_TYPE_COREGISTRANT
        Constant for the co-registrant access control relation.
        See Also:
        Constant Field Values
      • ACCESS_CONTROL_RELATION_TYPE_GIFT_GIVER

        public static final java.lang.String ACCESS_CONTROL_RELATION_TYPE_GIFT_GIVER
        Constant for the gift giver access control relation.
        See Also:
        Constant Field Values
      • GROUPING_ATTRIBUTE_ACCESS_SPECIFIER

        public static final java.lang.String GROUPING_ATTRIBUTE_ACCESS_SPECIFIER
        Constant for the grouping attribute name.
        See Also:
        Constant Field Values
    • Constructor Detail

      • GiftListTypeProtectableProxy

        public GiftListTypeProtectableProxy()
        Creates an instance of the protectable proxy object.
    • Method Detail

      • fulfills

        public boolean fulfills(java.lang.Long member,
                                java.lang.String relationship)
                         throws java.lang.Exception
        This method determines if a given member fulfills a given relationship with the resource. For all the action codes that are supported in the base code, the method performs the check required. For any custom action codes introduced, the method will return false.
        Specified by:
        fulfills in interface Protectable
        Overrides:
        fulfills in class com.ibm.commerce.security.AbstractProtectableProxy
        Parameters:
        member - This is the member id of the member.
        relationship - This is the relationship the member has with to the resource.
        Returns:
        true if the member fulfills the given relationship with the resource. false Otherwise.
        Throws:
        java.lang.Exception
        See Also:
        GiftListTypeProtectableProxy#checkUserFulfillsRegistrantOrCoregistrantRelationship(Long, String)}, GiftListTypeProtectableProxy#checkUserFulfillsGiftGiverRelationship(Long, String)}
      • getOwner

        public java.lang.Long getOwner()
                                throws java.lang.Exception
        This method will return the owner of the protectable object. If the owner has not been specified on the proxy object, then the owner will be the owner of the store that can be resolved from the command context.
        Specified by:
        getOwner in interface Protectable
        Overrides:
        getOwner in class com.ibm.commerce.security.AbstractProtectableProxy
        Returns:
        The owner of the protectable proxy.
        Throws:
        java.lang.Exception - A problem occurred while resolving the owner.
        See Also:
        Protectable.getOwner()
      • getGroupingAttributeValue

        public java.lang.Object getGroupingAttributeValue(java.lang.String attributeName,
                                                          GroupingContext context)
                                                   throws java.lang.Exception
        Returns the value of the specified attribute.
        Specified by:
        getGroupingAttributeValue in interface Groupable
        Parameters:
        attributeName - The name of the grouping attribute. The supported attribute is AccessSpecifier.
        context - The grouping context.
        Returns:
        the value of the specified attribute.
        Throws:
        java.lang.Exception