*** This class provides Binary Compatibility only, not Source Compatibility ***

Package com.sas.services.information.metadata

Class DavPerson

java.lang.Object
java.rmi.server.RemoteObject
java.rmi.server.RemoteServer
java.rmi.server.UnicastRemoteObject
com.sas.services.information.metadata.Metadata
com.sas.services.information.metadata.Folder
com.sas.services.information.metadata.DavPerson
All Implemented Interfaces:
FolderInterface, IdentityInterface, MetadataInterface, PersonInterface, MutableContainerInterface, PublicObjectContainerInterface, PublicObjectInterface, com.sas.services.util.UpgradeInterface, com.sas.storage.editableproperties.LocalizableProperties, Serializable, Remote
@SASScope("ALL") @BinaryCompatibilityOnly public class DavPerson extends Folder implements PersonInterface, Serializable
DAV Smart object implementation for PersonInterface. Represents a user/person.
Since:
1.0
See Also:

  • Constructor Details

    • DavPerson

      public DavPerson() throws RemoteException
      Creates a new DavPerson.
      Throws:
      RemoteException - if unable to export the remote object.

    • DavPerson

      public DavPerson(DAVPerson o) throws RemoteException
      Creates a new DavPerson that incorporates the person object passed to the constructor.
      Parameters:
      o - DAV person.
      Throws:
      RemoteException - if unable to export the remote object.

    • DavPerson

      protected DavPerson(Class theClass) throws RemoteException
      Creates a new DavPerson.
      Parameters:
      theClass - The subclass's class which will be used to determine appropriate RMI socket factories.
      Throws:
      RemoteException - if unable to export the remote object.

    • DavPerson

      protected DavPerson(DAVPerson o, Class theClass) throws RemoteException
      Creates a new DavPerson that incorporates the person object passed to the constructor.
      Parameters:
      o - DAV person.
      theClass - The subclass's class which will be used to determine appropriate RMI socket factories.
      Throws:
      RemoteException - if unable to export the remote object.

  • Method Details

    • getName

      public String getName() throws RemoteException
      Description copied from class: Metadata
      Gets the name of the object.

      Specified by:
      getName in interface PublicObjectInterface
      Overrides:
      getName in class Metadata
      Returns:
      The name String for the object.
      Throws:
      RemoteException - in the event of remote object failure.

    • getDisplayName

      public String getDisplayName() throws ServiceException, RemoteException
      Description copied from interface: IdentityInterface
      Get the identity's display name attribute.
      Specified by:
      getDisplayName in interface IdentityInterface
      Returns:
      The display name, or null if it hasn't been set.
      Throws:
      ServiceException - If a service level error occurs.
      RemoteException - In the event of remote object failure.

    • getEffectiveDispayName

      public String getEffectiveDispayName() throws ServiceException, RemoteException
      Description copied from interface: IdentityInterface
      Get the effective display name for the identity. If the display name is non-null, that will be returned. Otherwise, the name is returned.
      Specified by:
      getEffectiveDispayName in interface IdentityInterface
      Returns:
      The effective display name.
      Throws:
      ServiceException - If a service level error occurs.
      RemoteException - In the event of remote object failure.

    • getEffectiveDisplayName

      public String getEffectiveDisplayName() throws ServiceException, RemoteException
      Description copied from interface: IdentityInterface
      Get the effective display name for the identity. If the display name is non-null, that will be returned. Otherwise, the name is returned.
      Specified by:
      getEffectiveDisplayName in interface IdentityInterface
      Returns:
      The effective display name.
      Throws:
      ServiceException - If a service level error occurs.
      RemoteException - In the event of remote object failure.

    • setDisplayName

      public void setDisplayName(String displayName) throws ServiceException, RemoteException
      Description copied from interface: IdentityInterface
      Set the identity's display name. Most users will not have permission to perform this operation. Only user/group administrators will be able to change display names.
      Specified by:
      setDisplayName in interface IdentityInterface
      Parameters:
      displayName - The identity's new display name.
      Throws:
      ServiceException - If a repository error occurs.
      RemoteException - In the event of remote object failure.

    • getType

      public String getType() throws RemoteException
      Description copied from class: Folder
      Return a type string to identify this object.

      Specified by:
      getType in interface MetadataInterface
      Overrides:
      getType in class Folder
      Returns:
      The type string ("Folder").
      Throws:
      RemoteException - in the event of remote object failure.

    • getLogins

      public List getLogins() throws ServiceException, RemoteException
      Description copied from interface: IdentityInterface
      Get a list of the Login objects associated with this Identity.
      Specified by:
      getLogins in interface IdentityInterface
      Returns:
      a List of the Logins.
      Throws:
      ServiceException - in the event of a repository failure.
      RemoteException - in the event of remote object failure.

    • addLogin

      public void addLogin(LoginInterface login) throws ServiceException, RemoteException
      Description copied from interface: IdentityInterface
      Add a login to the Identity.
      Specified by:
      addLogin in interface IdentityInterface
      Parameters:
      login - The Login to add to this Identity.
      Throws:
      ServiceException - If a repository error occurs.
      RemoteException - In the event of remote object failure.

    • removeLogin

      public void removeLogin(LoginInterface login) throws ServiceException, RemoteException
      Description copied from interface: IdentityInterface
      Remove a Login from the Identity.
      Specified by:
      removeLogin in interface IdentityInterface
      Parameters:
      login - The Login to remove from this Identity.
      Throws:
      ServiceException - If a repository error occurs.
      RemoteException - In the event of remote object failure.

    • getUserIds

      public List getUserIds() throws ServiceException, RemoteException
      Description copied from interface: IdentityInterface
      Get a list of the user id's from the logins associated with this Identity.
      Specified by:
      getUserIds in interface IdentityInterface
      Returns:
      a List of the user id's.
      Throws:
      ServiceException - in the event of repository failure.
      RemoteException - in the event of remote object failure.

    • setName

      public void setName(String name) throws RemoteException
      Description copied from class: Folder
      Set the name of the object.

      Specified by:
      setName in interface MetadataInterface
      Overrides:
      setName in class Folder
      Parameters:
      name - The name of the object in the repository.
      Throws:
      RemoteException - in the event of remote object failure.

    • getEmailAddresses

      public List getEmailAddresses() throws RemoteException
      Description copied from interface: PersonInterface
      Get the user email addresses.

      Specified by:
      getEmailAddresses in interface PersonInterface
      Returns:
      A List of strings representing the user's email addresses.
      Throws:
      RemoteException - in the event of remote object failure.

    • addEmailAddress

      public void addEmailAddress(String address) throws RemoteException
      Description copied from interface: PersonInterface
      Add a new email address to a user's email address list.

      Specified by:
      addEmailAddress in interface PersonInterface
      Parameters:
      address - The new address to add.
      Throws:
      RemoteException - in the event of remote object failure.

    • removeEmailAddress

      public void removeEmailAddress(String address) throws RemoteException
      Description copied from interface: PersonInterface
      Remove an address from a user's list of email addresses.

      Specified by:
      removeEmailAddress in interface PersonInterface
      Parameters:
      address - The address to remove from the user's email list.
      Throws:
      RemoteException - in the event of remote object failure.

    • getEmails

      public List getEmails() throws RemoteException
      Description copied from interface: PersonInterface
      Get the user's email instances

      Specified by:
      getEmails in interface PersonInterface
      Returns:
      A List containing the user's email instances.
      Throws:
      RemoteException - in the event of remote object failure.

    • addEmail

      public void addEmail(EmailInterface ei) throws RemoteException
      Description copied from interface: PersonInterface
      Add a new email to a user's list of email instances.

      Specified by:
      addEmail in interface PersonInterface
      Throws:
      RemoteException - in the event of remote object failure.

    • removeEmail

      public void removeEmail(EmailInterface ei) throws RemoteException
      Description copied from interface: PersonInterface
      Remove an email from a user's list of email instances.

      Specified by:
      removeEmail in interface PersonInterface
      Throws:
      RemoteException - in the event of remote object failure.

    • getGroups

      public List getGroups() throws RemoteException
      Description copied from interface: MetadataInterface
      Get the list of groups this object is a member of.
      Specified by:
      getGroups in interface MetadataInterface
      Specified by:
      getGroups in interface PersonInterface
      Overrides:
      getGroups in class Metadata
      Returns:
      The List of GroupInterface objects this object is a member of.
      Throws:
      RemoteException - In the event of remote object failure.

    • getIdentityGroups

      public List getIdentityGroups() throws ServiceException, RemoteException
      Description copied from interface: IdentityInterface
      Get a List of the IdentityGroups that this Identity belongs to.
      Specified by:
      getIdentityGroups in interface IdentityInterface
      Returns:
      A List of IdentityGroupInterface objects that this identity is a direct member of.
      Throws:
      ServiceException - If a repository error occurs.
      RemoteException - In the event of remote object failure.

    • getSubscribers

      public List getSubscribers() throws ServiceException, RemoteException
      Description copied from interface: PersonInterface
      Get a List of the subscriber identities owned by this Person.

      Specified by:
      getSubscribers in interface PersonInterface
      Returns:
      a List of SubscriberInterface objects.
      Throws:
      ServiceException - if a repository error occurs.
      RemoteException - in the event of remote object failure.

    • getIdentityType

      public String getIdentityType() throws ServiceException, RemoteException
      Description copied from interface: IdentityInterface
      Return the type of Identity. This is mostly for internal use. Returns either "Person" or "IdentityGroup". To get the user friendly string, just use getType().
      Specified by:
      getIdentityType in interface IdentityInterface
      Returns:
      The identity type string.
      Throws:
      ServiceException - If a service level error occurs.
      RemoteException - In the event of remote object failure.

    • getTitle

      public String getTitle() throws ServiceException, RemoteException
      Description copied from interface: PersonInterface
      Get the Title attribute.
      Specified by:
      getTitle in interface PersonInterface
      Returns:
      The value of the Title attribute, or null if unset.
      Throws:
      ServiceException - If a repository error occurs.
      RemoteException - In the event of remote object failure.

    • setTitle

      public void setTitle(String title) throws ServiceException, RemoteException
      Description copied from interface: PersonInterface
      Set the Person's Title.
      Specified by:
      setTitle in interface PersonInterface
      Parameters:
      title - The new Title for the person.
      Throws:
      ServiceException - If a repository error occurs.
      RemoteException - In the event of remote object failure.

    • addLocation

      public void addLocation(LocationInterface location) throws ServiceException, RemoteException
      Description copied from interface: PersonInterface
      Add a location to the user's list of locations.
      Specified by:
      addLocation in interface PersonInterface
      Parameters:
      location - The new location to add.
      Throws:
      ServiceException - If a metadata error occurs.
      RemoteException - In the event of remote object failure.

    • addPhoneNumber

      public void addPhoneNumber(PhoneNumberInterface phone) throws ServiceException, RemoteException
      Description copied from interface: PersonInterface
      Add a phone number to the user's list.
      Specified by:
      addPhoneNumber in interface PersonInterface
      Parameters:
      phone - The new phone number to add.
      Throws:
      ServiceException - If a metadata error occurs.
      RemoteException - In the event of remote object failure.

    • getLocations

      public List getLocations() throws ServiceException, RemoteException
      Description copied from interface: PersonInterface
      Return the list of locations for the user. These may be valid addresses, but the description of Location in the metadata doesn't say that, so it could be just a country, etc.
      Specified by:
      getLocations in interface PersonInterface
      Returns:
      The List of locations defined for the user.
      Throws:
      ServiceException - If a metadata error occurs.
      RemoteException - In the event of remote object failure.

    • getPhoneNumbers

      public List getPhoneNumbers() throws ServiceException, RemoteException
      Description copied from interface: PersonInterface
      Get the list of phone numbers for the user.
      Specified by:
      getPhoneNumbers in interface PersonInterface
      Returns:
      The List of phone numbers defined for the user.
      Throws:
      ServiceException - If a metadata error occurs.
      RemoteException - In the event of remote object failure.

    • removeLocation

      public void removeLocation(LocationInterface location) throws ServiceException, RemoteException
      Description copied from interface: PersonInterface
      Remove a location from the user's list of lcoations.
      Specified by:
      removeLocation in interface PersonInterface
      Parameters:
      location - The location to remove.
      Throws:
      ServiceException - If a metadata error occurs.
      RemoteException - In the event of remote object failure.

    • removePhoneNumber

      public void removePhoneNumber(PhoneNumberInterface phone) throws ServiceException, RemoteException
      Description copied from interface: PersonInterface
      Remove a phone number from the user's list.
      Specified by:
      removePhoneNumber in interface PersonInterface
      Parameters:
      phone - The phone number to remove.
      Throws:
      ServiceException - If a metadata error occurs.
      RemoteException - In the event of remote object failure.

    • setInternalAccountPassword

      public void setInternalAccountPassword(String password) throws ServiceException, RemoteException
      Description copied from interface: PersonInterface
      Set Internal Account Password
      Specified by:
      setInternalAccountPassword in interface PersonInterface
      Parameters:
      password - The password (clear text or encoded) to be set for this Person
      Throws:
      ServiceException - If a metadata error occurs.
      RemoteException - In the event of remote object failure.

    • deleteInternalAccount

      public void deleteInternalAccount() throws ServiceException, RemoteException
      Description copied from interface: PersonInterface
      Delete Internal Account
      Specified by:
      deleteInternalAccount in interface PersonInterface
      Throws:
      ServiceException - If a metadata error occurs.
      RemoteException - In the event of remote object failure.

    • getInternalAccountOptions

      public InternalLoginUserInfo getInternalAccountOptions() throws ServiceException, RemoteException
      Description copied from interface: PersonInterface
      Return Internal Account (InternalLoginUserInfo) Options for this Person
      Specified by:
      getInternalAccountOptions in interface PersonInterface
      Throws:
      ServiceException - If a metadata error occurs.
      RemoteException - In the event of remote object failure.

    • setInternalAccountOptions

      public void setInternalAccountOptions(InternalLoginUserInfo intrlLgnUsrInfo) throws ServiceException, RemoteException
      Description copied from interface: PersonInterface
      Set Internal Account (InternalLoginUserInfo) Options for this Person
      Specified by:
      setInternalAccountOptions in interface PersonInterface
      Throws:
      ServiceException - If a metadata error occurs.
      RemoteException - In the event of remote object failure.

    • getIdentityMembershipLevels

      public List<IdentityMembershipInterface> getIdentityMembershipLevels() throws ServiceException, RemoteException
      Description copied from interface: IdentityInterface
      Returns the List of IdentityMembershipInterface instances ordered by membership level
      Specified by:
      getIdentityMembershipLevels in interface IdentityInterface
      Returns:
      List<IdentityMembershipInterface>
      Throws:
      ServiceException - If a service level error occurs.
      RemoteException - In the event of remote object failure.

    • getCreatedObjects

      public List<MetadataInterface> getCreatedObjects() throws ServiceException, RemoteException
      Description copied from interface: PersonInterface
      Returns the list of objects this person has created.

      Note, this can potentially be a fairly expensive request depending on how many objects the user has created.

      Specified by:
      getCreatedObjects in interface PersonInterface
      Returns:
      list of created objects
      Throws:
      ServiceException - If a service level error occurs.
      RemoteException - in the event of remote object failure.

    • getModifiedObjects

      public List<MetadataInterface> getModifiedObjects() throws ServiceException, RemoteException
      Description copied from interface: PersonInterface
      Returns the list of objects this person has modified.

      Note, this can potentially be a fairly expensive request depending on how many objects the user has modified.

      Specified by:
      getModifiedObjects in interface PersonInterface
      Returns:
      list of modified objects
      Throws:
      ServiceException - If a service level error occurs.
      RemoteException - in the event of remote object failure.

    • getExternalIdentities

      public List<ExternalIdentityInterface> getExternalIdentities() throws ServiceException, RemoteException
      Description copied from interface: IdentityInterface
      Get a list of the External Identity objects associated with this Identity.
      Specified by:
      getExternalIdentities in interface IdentityInterface
      Returns:
      a List of the External Identities.
      Throws:
      ServiceException - in the event of a repository failure.
      RemoteException - in the event of remote object failure.

    • addExternalIdentity

      public void addExternalIdentity(ExternalIdentityInterface externalIdentity) throws ServiceException, RemoteException
      Description copied from interface: IdentityInterface
      Add an external identity to the Identity.
      Specified by:
      addExternalIdentity in interface IdentityInterface
      Parameters:
      externalIdentity - The external identity to add to this Identity.
      Throws:
      ServiceException - If a repository error occurs.
      RemoteException - In the event of remote object failure.

    • removeExternalIdentity

      public void removeExternalIdentity(ExternalIdentityInterface externalIdentity) throws ServiceException, RemoteException
      Description copied from interface: IdentityInterface
      Remove an external identity from the Identity.
      Specified by:
      removeExternalIdentity in interface IdentityInterface
      Parameters:
      externalIdentity - The external identity to remove from this Identity.
      Throws:
      ServiceException - If a repository error occurs.
      RemoteException - In the event of remote object failure.