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

com.sas.services.information.metadata
Class AuthenticatedIdentity

com.sas.services.information.metadata.AuthenticatedIdentity
All Implemented Interfaces:
IdentityInterface, MetadataInterface, PersonInterface, PublicObjectInterface, java.io.Serializable, java.rmi.Remote

public class AuthenticatedIdentity
implements PersonInterface

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.sas.services.information.metadata.MetadataInterface
METADATA_STATE_DELETED, METADATA_STATE_DESTROYED, METADATA_STATE_NEW, METADATA_STATE_NORMAL, PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA
 
Constructor Summary
AuthenticatedIdentity()
           
 
Method Summary
 void addEmail(EmailInterface ei)
          Add a new email to a user's list of email instances.
 void addEmailAddress(java.lang.String address)
          Add a new email address to a user's email address list.
 void addLocation(LocationInterface location)
          Add a location to the user's list of locations.
 void addLogin(LoginInterface login)
          Add a login to the Identity Group.
 void addPhoneNumber(PhoneNumberInterface phone)
          Add a phone number to the user's list.
 void deleteInternalAccount()
          Delete Internal Account
 java.lang.String getDisplayName()
          Get the identity's display name attribute.
 java.lang.String getEffectiveDispayName()
          Get the effective display name for the identity.
 java.lang.String getEffectiveDisplayName()
          Get the effective display name for the identity.
 java.util.List getEmailAddresses()
          Get the user email addresses.
 java.util.List getEmails()
          Get the user's email instances
 java.util.List getGroups()
          Get the list of groups this object is a member of.
 java.util.List getIdentityGroups()
          Get a List of the IdentityGroups that this Identity belongs to.
 java.util.List<IdentityMembershipInterface> getIdentityMembershipLevels()
          Returns the List of IdentityMembershipInterface instances ordered by membership level
 java.lang.String getIdentityType()
          Return the type of Identity.
 InternalLoginUserInfo getInternalAccountOptions()
          Return Internal Account (InternalLoginUserInfo) Options for this Person
 java.util.List getLocations()
          Return the list of locations for the user.
 java.util.List getLogins()
          Get a list of the Login objects associated with this Identity.
 java.lang.String getName()
          Get the name of this object.
 java.util.List getPhoneNumbers()
          Get the list of phone numbers for the user.
 java.util.List getSubscribers()
          Get a List of the subscriber identities owned by this Person.
 java.lang.String getTitle()
          Get the Title attribute.
 java.lang.String getType()
          Get the object type.
 java.util.List getUserIds()
          Get a list of the user id's from the logins associated with this Identity.
 void removeEmail(EmailInterface ei)
          Remove an email from a user's list of email instances.
 void removeEmailAddress(java.lang.String address)
          Remove an address from a user's list of email addresses.
 void removeLocation(LocationInterface location)
          Remove a location from the user's list of lcoations.
 void removeLogin(LoginInterface login)
          Remove a Login from the Identity Group.
 void removePhoneNumber(PhoneNumberInterface phone)
          Remove a phone number from the user's list.
 void setDisplayName(java.lang.String displayName)
          Set the identity's display name.
 void setInternalAccountOptions(InternalLoginUserInfo intrlLgnUsrInfo)
          Set Internal Account (InternalLoginUserInfo) Options for this Person
 void setInternalAccountPassword(java.lang.String password)
          Set Internal Account Password
 void setName(java.lang.String name)
          Set this object's name.
 void setTitle(java.lang.String title)
          Set the Person's Title.
 
Methods inherited from class com.sas.services.information.metadata.VirtualMetadata
add, addAccessControl, addAttribute, addAttributes, addDocument, addExtension, addGroup, addImplementor, addKeyword, addObjectProperty, addObjectProperty, addPermissions, addProcessorInterface, addPrompt, addPropertySet, addRemark, addResponsibleParty, addTransactionListener, addUsedByPrototype, checkin, checkout, commit, copyTo, countAssociatedObjects, delete, deleteAttribute, deleteAttributes, destroy, getAccessControls, getAttribute, getAttributes, getAuthorizationUtil, getContainer, getCreateDate, getDescription, getDocuments, getEntityKey, getEntityURL, getExtensions, getGUID, getIdentifier, getIdentities, getImplementors, getKeywords, getLockedBy, getModifyDate, getObjectProperties, getObjectURI, getParent, getParentPath, getParents, getPath, getPaths, getPathUrl, getPathUrl, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getPrimaryPropertyGroup, getProcessorInterface, getPrompt, getPrompts, getPropertyBag, getPropertySets, getRemarksList, getReposId, getRepository, getRepositoryEntity, getRepositoryName, getReposKey, getResponsibleParties, getState, getTrackingId, getTypeDescriptor, getUsageVersion, getUsedByPrototypes, getUsingPrototype, getVersion, isAuthorized, isCompatible, isDeleted, isDestroyed, isLoggingEnabled, isObjectAlive, isReadCompatible, logMessage, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, refresh, removeAccessControl, removeDocument, removeExtension, removeGroup, removeImplementor, removeKeyword, removeObjectProperty, removePermissions, removePrompt, removePropertySet, removeResponsibleParty, removeUsedByPrototype, rollback, setAttribute, setAttributes, setDeleted, setDescription, setDocuments, setExtensions, setGroups, setGUID, setKeywords, setObjectProperties, setPermission, setPrimaryPropertyGroup, setPrompt, setPrompts, setRemarksList, setRepository, setUsingPrototype, startTransaction, toByteArray, transactionEvent, uncheckout, update, updateFromBag, version
 
Methods inherited from interface com.sas.services.information.metadata.MetadataInterface
add, addAccessControl, addAttribute, addAttributes, addDocument, addExtension, addGroup, addImplementor, addKeyword, addObjectProperty, addObjectProperty, addPermissions, addPrompt, addPropertySet, addRemark, addResponsibleParty, addTransactionListener, addUsedByPrototype, checkin, checkout, commit, copyTo, countAssociatedObjects, delete, deleteAttribute, deleteAttributes, destroy, getAccessControls, getAttribute, getAttributes, getAuthorizationUtil, getCreateDate, getDescription, getDocuments, getEntityKey, getEntityURL, getExtensions, getGUID, getIdentities, getImplementors, getKeywords, getLockedBy, getModifyDate, getObjectProperties, getParent, getParentPath, getParents, getPath, getPaths, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getPrimaryPropertyGroup, getPrompt, getPrompts, getPropertyBag, getPropertySets, getRemarksList, getReposId, getRepository, getRepositoryEntity, getRepositoryName, getReposKey, getResponsibleParties, getState, getTrackingId, getUsageVersion, getUsedByPrototypes, getUsingPrototype, getVersion, isAuthorized, isCompatible, isDeleted, isDestroyed, isLoggingEnabled, isObjectAlive, isReadCompatible, logMessage, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, refresh, removeAccessControl, removeDocument, removeExtension, removeGroup, removeImplementor, removeKeyword, removeObjectProperty, removePermissions, removePrompt, removePropertySet, removeResponsibleParty, removeUsedByPrototype, rollback, setAttribute, setAttributes, setDeleted, setDescription, setDocuments, setExtensions, setGroups, setGUID, setKeywords, setObjectProperties, setPermission, setPrimaryPropertyGroup, setPrompt, setPrompts, setRemarksList, setRepository, setUsingPrototype, startTransaction, toByteArray, transactionEvent, uncheckout, update, updateFromBag, version
 
Methods inherited from interface com.sas.services.information.publicobject.PublicObjectInterface
addProcessorInterface, getContainer, getIdentifier, getObjectURI, getPathUrl, getProcessorInterface, getTypeDescriptor
 

Constructor Detail

AuthenticatedIdentity

public AuthenticatedIdentity()
Method Detail

getName

public java.lang.String getName()
                         throws java.rmi.RemoteException
Description copied from interface: PublicObjectInterface
Get the name of this object.

Specified by:
getName in interface PublicObjectInterface
Overrides:
getName in class VirtualMetadata
Returns:
String
Throws:
java.rmi.RemoteException

getType

public java.lang.String getType()
                         throws java.rmi.RemoteException
Description copied from interface: MetadataInterface
Get the object type. Subclasses of Metadata will return a repository-neutral type string. If no subclass exists, Metadata returns the repository-specific type.

Specified by:
getType in interface MetadataInterface
Overrides:
getType in class VirtualMetadata
Returns:
A type string for the object.
Throws:
java.rmi.RemoteException - if an error occurs

getLogins

public java.util.List getLogins()
                         throws ServiceException,
                                java.rmi.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.
java.rmi.RemoteException - in the event of remote object failure.

getUserIds

public java.util.List getUserIds()
                          throws ServiceException,
                                 java.rmi.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.
java.rmi.RemoteException - in the event of remote object failure.

setName

public void setName(java.lang.String name)
             throws java.rmi.RemoteException
Description copied from interface: MetadataInterface
Set this object's name.

Specified by:
setName in interface MetadataInterface
Overrides:
setName in class VirtualMetadata
Parameters:
name - a String for the object name.
Throws:
java.rmi.RemoteException - if an error occurs

getEmailAddresses

public java.util.List getEmailAddresses()
                                 throws java.rmi.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:
java.rmi.RemoteException - in the event of remote object failure.

addEmailAddress

public void addEmailAddress(java.lang.String address)
                     throws java.rmi.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:
java.rmi.RemoteException - in the event of remote object failure.

removeEmailAddress

public void removeEmailAddress(java.lang.String address)
                        throws java.rmi.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:
java.rmi.RemoteException - in the event of remote object failure.

getEmails

public java.util.List getEmails()
                         throws java.rmi.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:
java.rmi.RemoteException - in the event of remote object failure.

addEmail

public void addEmail(EmailInterface ei)
              throws java.rmi.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:
java.rmi.RemoteException - in the event of remote object failure.

removeEmail

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

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

getGroups

public java.util.List getGroups()
                         throws java.rmi.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 VirtualMetadata
Returns:
The List of GroupInterface objects this object is a member of.
Throws:
java.rmi.RemoteException - In the event of remote object failure.

getIdentityGroups

public java.util.List getIdentityGroups()
                                 throws ServiceException,
                                        java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

getSubscribers

public java.util.List getSubscribers()
                              throws ServiceException,
                                     java.rmi.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.
java.rmi.RemoteException - in the event of remote object failure.

addLogin

public void addLogin(LoginInterface login)
              throws ServiceException,
                     java.rmi.RemoteException
Description copied from interface: IdentityInterface
Add a login to the Identity Group.

Specified by:
addLogin in interface IdentityInterface
Parameters:
login - The Login to add to this Identity Group.
Throws:
ServiceException - If a repository error occurs.
java.rmi.RemoteException - In the event of remote object failure.

removeLogin

public void removeLogin(LoginInterface login)
                 throws ServiceException,
                        java.rmi.RemoteException
Description copied from interface: IdentityInterface
Remove a Login from the Identity Group.

Specified by:
removeLogin in interface IdentityInterface
Parameters:
login - The Login to remove from this Identity Group.
Throws:
ServiceException - If a repository error occurs.
java.rmi.RemoteException - In the event of remote object failure.

getDisplayName

public java.lang.String getDisplayName()
                                throws ServiceException,
                                       java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

setDisplayName

public void setDisplayName(java.lang.String displayName)
                    throws ServiceException,
                           java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

getEffectiveDispayName

public java.lang.String getEffectiveDispayName()
                                        throws ServiceException,
                                               java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

getEffectiveDisplayName

public java.lang.String getEffectiveDisplayName()
                                         throws ServiceException,
                                                java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

getIdentityType

public java.lang.String getIdentityType()
                                 throws ServiceException,
                                        java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

getTitle

public java.lang.String getTitle()
                          throws ServiceException,
                                 java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

setTitle

public void setTitle(java.lang.String title)
              throws ServiceException,
                     java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

addLocation

public void addLocation(LocationInterface location)
                 throws ServiceException,
                        java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

addPhoneNumber

public void addPhoneNumber(PhoneNumberInterface phone)
                    throws ServiceException,
                           java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

getLocations

public java.util.List getLocations()
                            throws ServiceException,
                                   java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

getPhoneNumbers

public java.util.List getPhoneNumbers()
                               throws ServiceException,
                                      java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

removeLocation

public void removeLocation(LocationInterface location)
                    throws ServiceException,
                           java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

removePhoneNumber

public void removePhoneNumber(PhoneNumberInterface phone)
                       throws ServiceException,
                              java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

setInternalAccountPassword

public void setInternalAccountPassword(java.lang.String password)
                                throws ServiceException,
                                       java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

deleteInternalAccount

public void deleteInternalAccount()
                           throws ServiceException,
                                  java.rmi.RemoteException
Description copied from interface: PersonInterface
Delete Internal Account

Specified by:
deleteInternalAccount in interface PersonInterface
Throws:
ServiceException - If a metadata error occurs.
java.rmi.RemoteException - In the event of remote object failure.

getInternalAccountOptions

public InternalLoginUserInfo getInternalAccountOptions()
                                                throws ServiceException,
                                                       java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

setInternalAccountOptions

public void setInternalAccountOptions(InternalLoginUserInfo intrlLgnUsrInfo)
                               throws ServiceException,
                                      java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

getIdentityMembershipLevels

public java.util.List<IdentityMembershipInterface> getIdentityMembershipLevels()
                                                                        throws ServiceException,
                                                                               java.rmi.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.
java.rmi.RemoteException - In the event of remote object failure.

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




Copyright © 2009 SAS Institute Inc. All Rights Reserved.