Package com.sun.identity.console.idm.model

Interface EntitiesModel

    • Method Detail

      • getPropertyXMLString

        String getPropertyXMLString​(String realmName,
                            String idType,
                            String agentType,
                            boolean bCreate,
                            String viewbeanClassName)
                     throws AMConsoleException
        Returns property sheet XML for Entity Profile.
        Parameters:
        realmName - Name of Realm.
        idType - Type of Entity.
        agentType - mainly for agent type.
        bCreate - true for creation operation.
        viewbeanClassName - Class Name of View Bean.
        Returns:
        property sheet XML for Entity Profile.
        Throws:
        AMConsoleException - if XML cannot be obtained.

      • getDefaultAttributeValues

        Map getDefaultAttributeValues​(String idType,
                              String agentType,
                              boolean bCreate)
                       throws AMConsoleException
        Returns defauls values for an Entity Type.
        Parameters:
        idType - Type of Entity.
        agentType - mainly for agent type.
        bCreate - true for Creation page.
        Throws:
        AMConsoleException - if default values cannot be obtained.

      • getAttributeValues

        Map getAttributeValues​(String universalId,
                       boolean bCreate)
                throws AMConsoleException
        Returns attribute values of an entity object.
        Parameters:
        universalId - Universal ID of the entity.
        bCreate - true for creation page.
        Returns:
        attribute values of an entity object.
        Throws:
        AMConsoleException - if object cannot located.

      • createEntity

        void createEntity​(String realmName,
                  String entityName,
                  String idType,
                  Map values)
           throws AMConsoleException
        Creates an entity.
        Parameters:
        realmName - Name of Realm.
        entityName - Name of Entity.
        idType - Type of Entity.
        values - Map of attribute name to Set of attribute values.
        Throws:
        AMConsoleException - if entity cannot be created.

      • modifyEntity

        void modifyEntity​(String realmName,
                  String universalId,
                  Map values)
           throws AMConsoleException
        Modifies profile of entity.
        Parameters:
        realmName - Name of Realm.
        universalId - Universal ID of the entity.
        values - Map of attribute name to set of attribute values.
        Throws:
        AMConsoleException - if entity cannot be located or modified.

      • deleteEntities

        void deleteEntities​(String realmName,
                    Set names)
             throws AMConsoleException
        Deletes entities.
        Parameters:
        realmName - Name of Realm.
        names - Name of Entities to be deleted.
        Throws:
        AMConsoleException - if entity cannot be deleted.

      • canAssignService

        boolean canAssignService​(String realmName,
                         String idType)
        Returns true if services can be assigned to this entity type.
        Parameters:
        realmName - Name of Realm.
        idType - Type of Entity.
        Returns:
        true if services can be assigned to this entity type.

      • getIdTypeMemberOf

        Set getIdTypeMemberOf​(String realmName,
                      String idType)
               throws AMConsoleException
        Returns a set of entity types of which a given type can have member of.
        Parameters:
        realmName - Name of Realm.
        idType - Type of Entity.
        Returns:
        a set of entity types of which a given type can have member of.
        Throws:
        AMConsoleException - if idType is not supported.

      • getIdTypeBeMemberOf

        Set getIdTypeBeMemberOf​(String realmName,
                        String idType)
                 throws AMConsoleException
        Returns a set of entity types that can be member of a given type.
        Parameters:
        realmName - Name of Realm.
        idType - Type of Entity.
        Returns:
        a set of entity types that can be member of a given type.
        Throws:
        AMConsoleException - if idType is not supported.

      • canAddMember

        boolean canAddMember​(String realmName,
                     String idType,
                     String containerIDType)
              throws AMConsoleException
        Returns true of members can be added to a type.
        Parameters:
        realmName - Name of Realm.
        idType - Type of Entity.
        containerIDType - Type of Entity of Container.
        Returns:
        true of members can be added to a type.
        Throws:
        AMConsoleException

      • getMembership

        Set getMembership​(String realmName,
                  String universalId,
                  String type)
           throws AMConsoleException
        Returns membership of an entity.
        Parameters:
        realmName - Name of Realm.
        universalId - Universal ID of the entity.
        type - Type of membership.
        Returns:
        membership of an entity.
        Throws:
        AMConsoleException - if members cannot be returned.

      • getMembers

        Set getMembers​(String realmName,
               String universalId,
               String type)
        throws AMConsoleException
        Returns members of an entity.
        Parameters:
        realmName - Name of Realm.
        universalId - Universal ID of the entity.
        type - Type of membership.
        Returns:
        members of an entity.
        Throws:
        AMConsoleException - if members cannot be returned.

      • addMemberships

        void addMemberships​(String universalId,
                    Set membership)
             throws AMConsoleException
        Adds an entity to a set of membership.
        Parameters:
        universalId - Universal ID of the entity.
        membership - Set of Universal ID of membership.
        Throws:
        AMConsoleException - if membership addition fails.

      • addMembers

        void addMembers​(String universalId,
                Set names)
         throws AMConsoleException
        Adds an entities to a membership.
        Parameters:
        universalId - Universal ID of the membership.
        names - Set of Universal ID of entities.
        Throws:
        AMConsoleException - if membership addition fails.

      • removeMemberships

        void removeMemberships​(String universalId,
                       Set membership)
                throws AMConsoleException
        Removes an entity from a set of memberships.
        Parameters:
        universalId - Universal ID of the entity.
        membership - Set of Universal ID of membership.
        Throws:
        AMConsoleException - if membership removal fails.

      • removeMembers

        void removeMembers​(String universalId,
                   Set names)
            throws AMConsoleException
        Removes a set of entities from a membership.
        Parameters:
        universalId - Universal ID of the membership.
        names - Set of Universal ID of entities.
        Throws:
        AMConsoleException - if membership removal fails.

      • getAssignedMemberships

        Set getAssignedMemberships​(String universalId,
                           Set memberships)
                    throws AMConsoleException
        Returns assigned memberships.
        Parameters:
        universalId - Universal ID of the entity.
        memberships - Set of assignable memberships.
        Throws:
        AMConsoleException - if memberships information cannot be determined.

      • getAssignedMembers

        Set getAssignedMembers​(String universalId,
                       Set members)
                throws AMConsoleException
        Returns assigned members.
        Parameters:
        universalId - Universal ID of the entity.
        members - Set of assignable members.
        Throws:
        AMConsoleException - if members information cannot be determined.

      • getAssignedServiceNames

        Map getAssignedServiceNames​(String universalId)
                     throws AMConsoleException
        Returns assigned services. Map of service name to its display name.
        Parameters:
        universalId - Universal ID of the entity.
        Returns:
        assigned services.
        Throws:
        AMConsoleException - if service information cannot be determined.

      • getAssignableServiceNames

        Map getAssignableServiceNames​(String universalId)
                       throws AMConsoleException
        Returns assignable services. Map of service name to its display name.
        Parameters:
        universalId - Universal ID of the entity.
        Returns:
        assignable services.
        Throws:
        AMConsoleException - if service information cannot be determined.

      • getServicePropertySheetXML

        String getServicePropertySheetXML​(String realmName,
                                  String serviceName,
                                  IdType idType,
                                  boolean bCreate,
                                  String viewbeanClassName)
                           throws AMConsoleException
        Returns the XML for property sheet view component.
        Parameters:
        realmName - Name of Realm.
        serviceName - Name of service.
        idType - type of Identity.
        bCreate - true if the property sheet is for identity creation.
        viewbeanClassName - Class Name of View Bean.
        Returns:
        the XML for property sheet view component.
        Throws:
        AMConsoleException - if XML cannot be created.

      • getDefaultValues

        Map getDefaultValues​(String serviceName,
                     String idType)
              throws AMConsoleException
        Returns defauls values for an Entity Type.
        Parameters:
        idType - ID Type;
        serviceName - Name of service name.
        Throws:
        AMConsoleException - if default values cannot be obtained.

      • assignService

        void assignService​(String universalId,
                   String serviceName,
                   Map values)
            throws AMConsoleException
        Assigns service to an entity.
        Parameters:
        universalId - Universal ID of the entity.
        serviceName - Service names.
        values - Attribute Values of the service.
        Throws:
        AMConsoleException - if service cannot be assigned.

      • unassignServices

        void unassignServices​(String universalId,
                      Set serviceNames)
               throws AMConsoleException
        Unassigns services from an entity.
        Parameters:
        universalId - Universal ID of the entity.
        serviceNames - Set of service names to be unassigned.
        Throws:
        AMConsoleException - if services cannot be unassigned.

      • getPropertiesViewBean

        String getPropertiesViewBean​(String name)
        Returns properties view bean URL for an attribute schema.
        Parameters:
        name - Name of attribute schema.
        Returns:
        properties view bean URL for an attribute schema.

      • getServiceAttributeValues

        Map getServiceAttributeValues​(String universalId,
                              String serviceName)
                       throws AMConsoleException
        Returns service attribute values of an entity.
        Parameters:
        universalId - Universal ID of the entity.
        serviceName - Name of service name.
        Returns:
        service attribute values of entity.
        Throws:
        AMConsoleException - if values cannot be returned.

      • setServiceAttributeValues

        void setServiceAttributeValues​(String universalId,
                               String serviceName,
                               Map values)
                        throws AMConsoleException
        Set service attribute values to an entity.
        Parameters:
        universalId - Universal ID of the entity.
        serviceName - Name of service name.
        values - Attribute values.
        Throws:
        AMConsoleException - if values cannot be set.

      • hasUserAttributeSchema

        boolean hasUserAttributeSchema​(String serviceName)
        Returns true if service has user attribute schema.
        Parameters:
        serviceName - Name of service.
        Returns:
        true if service has user attribute schema.

      • hasDisplayableAttributes

        boolean hasDisplayableAttributes​(String serviceName)
        Returns true if service has displayable user or dynamic attributes.
        Parameters:
        serviceName - Name of service.
        Returns:
        true if service has displayable attributes.

      • getServiceNameForIdType

        String getServiceNameForIdType​(String idType,
                               String agentType)
        Returns service name of a given ID type.
        Parameters:
        idType - ID Type.
        agentType - Agent Type.
        Returns:
        service name of a given ID type.

      • setEndUser

        void setEndUser​(boolean endUser)
        Set end user flag.
        Parameters:
        endUser - end user flag.

      • getEntityType

        String getEntityType()
        Returns the type of entity object for which the model was constructed.
        Returns:
        type of entity object being used.

      • getAuthenticationChains

        Set getAuthenticationChains​(String realm)
                     throws AMConsoleException
        Returns all the authentication chains in a realm.
        Parameters:
        realm - Name of realm.
        Returns:
        all the authentication chains in a realm.
        Throws:
        AMConsoleException - if authentication chains cannot be returned.

      • isServicesSupported

        boolean isServicesSupported()
        Returns true if services is supported for the identity.
        Returns:
        true if services is supported for the identity.

      • repoExists

        boolean repoExists​(String realmName)