com.ibm.itim.pim.authority
Class SharedAccessSearchFilter

java.lang.Object
  extended by com.ibm.itim.pim.authority.SharedAccessSearchFilter
All Implemented Interfaces:
java.io.Serializable

public class SharedAccessSearchFilter
extends java.lang.Object
implements java.io.Serializable

This class defines the search attributes for the shared accesses. A shared access represents a credential or a credential pool.

Since:
6.0
See Also:
Serialized Form

Nested Class Summary
static class SharedAccessSearchFilter.AccountStatus
           Enumeration of Account status
ACTIVE - indicates search only active accounts credential INACTIVE - indicates search only inactive accounts credential ALL - indicates search both active and inactive accounts credential
static class SharedAccessSearchFilter.ExclusiveOption
          Enumeration of Credential exclusive option EXCLUSIVE - indicates search only credentials configured as exclusive checkout NONEXCLUSIVE - indicates search only credentials configured as non-exclusive checkout search ALL - indicates search credentials regardless of exclusivity
static class SharedAccessSearchFilter.SearchOption
          Enumeration of Credential search option ENABLED - indicates search only credentials enabled for checkout search DISABLED - indicates search only credentials disabled for checkout search ALL - indicates search credentials regardless of the checkout search setting
static class SharedAccessSearchFilter.ViewPasswordOption
          Enumeration of password viewable option ENABLED - indicates search only credentials which password are viewable DISABLED - indicates search only credentials which password are not viewable ALL - indicates search credentials regardless if password are viewable
 
Constructor Summary
SharedAccessSearchFilter()
          default Constructor.
 
Method Summary
 SharedAccessSearchFilter.AccountStatus getAccountStatus()
          Return the account status.
 DistinguishedName getBusinessUnitDN()
          Return the DistinguishedName of business unit.
 SharedAccessSearchFilter.ExclusiveOption getExclusiveOption()
          Return the credential exclusive option.
 java.lang.String getName()
          Returns the matching string for account UID or pool name.
 DistinguishedName getOwnerBU()
          Return the distinguishedName of the credential owner BU
 java.lang.String getOwnerName()
          Return the name of the owner
 java.lang.String getOwnershipTypeName()
          return the name of the ownership type
 java.lang.String getPoolSearchInfo()
          Returns the matching string for pool name or pool description.
 SharedAccessSearchFilter.SearchOption getSearchOption()
          Return the credential search option.
 DistinguishedName getServiceDN()
          Return the DistinguishedName of the service Empty String is interpreted as any service.
 java.lang.String getServiceName()
          Return the matching string of the service name.
 java.lang.String getServiceProfileName()
          Return the service profile name.
 SharedAccessSearchFilter.ViewPasswordOption getViewPasswordOption()
          Return the view password option.
 boolean includeGlobalSettingsOnly()
          Indicates whether to only include credentials that use global settings
 void setAccountStatus(SharedAccessSearchFilter.AccountStatus status)
          Set the account status.
 void setBusinessUnitDN(DistinguishedName buDN)
          Set the DistinguishedName of business unit.
 void setExclusiveOption(SharedAccessSearchFilter.ExclusiveOption exclusiveOption)
          Set the credential exclusive option.
 void setIncludeGlobalSettingsOnly(boolean globalOnly)
          Indicates whether to only include credentials that use global settings
 void setName(java.lang.String name)
          Set the matching string for the account uid or credential pool name.
 void setOwnerBU(DistinguishedName bu)
          Set the distinguishedName of the credential owner BU
 void setOwnerName(java.lang.String namePattern)
          Set the name of the owner
 void setOwnershipTypeName(java.lang.String name)
          Set the name of the ownership type
 void setPoolSearchInfo(java.lang.String value)
          Set the matching string for pool name or description.
 void setSearchOption(SharedAccessSearchFilter.SearchOption searchOption)
          Set the credential search option.
 void setServiceDN(DistinguishedName serviceDN)
          Set the distinguished name of the service.
 void setServiceName(java.lang.String serviceName)
          Set the DN of the service name.
 void setServiceProfileName(java.lang.String serviceProfileName)
          Set the service profile name.
 void setViewPasswordOption(SharedAccessSearchFilter.ViewPasswordOption viewPasswordOption)
          Set the view password option.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SharedAccessSearchFilter

public SharedAccessSearchFilter()
default Constructor.

Method Detail

getName

public java.lang.String getName()
Returns the matching string for account UID or pool name. Empty String is interpreted as any credential or pool.

Returns:
the matching string for account UID or pool name.

getServiceProfileName

public java.lang.String getServiceProfileName()
Return the service profile name. Empty String is interpreted as any services.

Returns:
the service profile name.

getServiceName

public java.lang.String getServiceName()
Return the matching string of the service name. Empty String is interpreted as any service.

Returns:
the matching string of the service name.

getBusinessUnitDN

public DistinguishedName getBusinessUnitDN()
Return the DistinguishedName of business unit. For credential, it is the service business unit. For pool, it is the pool business unit. Empty String is interpreted as any business unit.

Returns:
the DistinguishedName of the business unit.

getServiceDN

public DistinguishedName getServiceDN()
Return the DistinguishedName of the service Empty String is interpreted as any service.

Returns:
the DistinguishedName of the service

getOwnershipTypeName

public java.lang.String getOwnershipTypeName()
return the name of the ownership type

Returns:
the name of the ownership type

getOwnerName

public java.lang.String getOwnerName()
Return the name of the owner

Returns:
the name of the owner

getOwnerBU

public DistinguishedName getOwnerBU()
Return the distinguishedName of the credential owner BU

Returns:
the distinguishedName of the credential owner BU

getPoolSearchInfo

public java.lang.String getPoolSearchInfo()
Returns the matching string for pool name or pool description. Empty String is interpreted as any pool.

Returns:
the matching string for pool name or pool description.

getExclusiveOption

public SharedAccessSearchFilter.ExclusiveOption getExclusiveOption()
Return the credential exclusive option. Valid values are: ExclusiveOption.EXCLUSIVE, ExclusiveOption.NONEXCLUSIVE, or ExclusiveOption.ALL. ExclusiveOption.ALL is interpreted as any shared credential (either exclusive or non-exclusive).

Returns:
the enumerated ExclusiveOption value.

getSearchOption

public SharedAccessSearchFilter.SearchOption getSearchOption()
Return the credential search option. Valid values are: SearchOption.ENABLED, SearchOption.DISABLED, or SearchOption.ALL. SearchOption.ALL is interpreted as any credential.

Returns:
the enumerated SearchOption value.

getViewPasswordOption

public SharedAccessSearchFilter.ViewPasswordOption getViewPasswordOption()
Return the view password option. Valid values are: ViewPasswordOption.ENABLED, ViewPasswordOption.DISABLED, or ViewPasswordOption.ALL. ViewPasswordOption.ALL is interpreted as any credential.

Returns:
the enumerated ViewPasswordOption value.

getAccountStatus

public SharedAccessSearchFilter.AccountStatus getAccountStatus()
Return the account status. Valid values are: AccountStatus.ACTIVE, AccountStatus.INACTIVE, or AccountStatus.ALL. AccountStatus.ALL is interpreted as any credential.

Returns:
the enumerated AccountStatus value.

includeGlobalSettingsOnly

public boolean includeGlobalSettingsOnly()
Indicates whether to only include credentials that use global settings

Returns:
true if only include credentilas that use global settings and false otherwise

setName

public void setName(java.lang.String name)
Set the matching string for the account uid or credential pool name.

Parameters:
name - The account uid or pool name matching string The asterisk character ('*') can be used to match any string in any length (including zero length).

setServiceDN

public void setServiceDN(DistinguishedName serviceDN)
Set the distinguished name of the service.

Parameters:
serviceDN - The distinguished name of the service.

setServiceName

public void setServiceName(java.lang.String serviceName)
Set the DN of the service name.

Parameters:
serviceName - The service name matching string. The asterisk character ('*') can be used to match any string in any length (including zero length).

setServiceProfileName

public void setServiceProfileName(java.lang.String serviceProfileName)
Set the service profile name. A empty string represents all services.

Parameters:
name - The service profile name. The asterisk character ('*') can be used to match any string in any length (including zero length).

setBusinessUnitDN

public void setBusinessUnitDN(DistinguishedName buDN)
Set the DistinguishedName of business unit. For credential, it is the service business unit. For pool, it is the pool business unit.

Parameters:
buDN - The DistinguishedName of business unit.

setSearchOption

public void setSearchOption(SharedAccessSearchFilter.SearchOption searchOption)
Set the credential search option. Valid values are: SearchOption.ENABLED, SearchOption.DISABLED, or SearchOption.ALL. SearchOption.ALL is interpreted as any credential.

Parameters:
searchOption - the enumerated SearchOption value.

setExclusiveOption

public void setExclusiveOption(SharedAccessSearchFilter.ExclusiveOption exclusiveOption)
Set the credential exclusive option. Valid values are: ExclusiveOption.EXCLUSIVE, ExclusiveOption.NONEXCLUSIVE, or ExclusiveOption.ALL. ExclusiveOption.ALL is interpreted as any shared credential (either exclusive or non-exclusive).

Parameters:
exclusiveOption - the enumerated ExclusiveOption value.

setAccountStatus

public void setAccountStatus(SharedAccessSearchFilter.AccountStatus status)
Set the account status. Valid values are: AccountStatus.ACTIVE, AccountStatus.INACTIVE, or AccountStatus.ALL. AccountStatus.ALL is interpreted as any credential.

Parameters:
status - the enumerated AccountStatus value.

setViewPasswordOption

public void setViewPasswordOption(SharedAccessSearchFilter.ViewPasswordOption viewPasswordOption)
Set the view password option. Valid values are: ViewPasswordOption.ENABLED, ViewPasswordOption.DISABLED, or ViewPasswordOption.ALL. viewPasswordOption.ALL is interpreted as any credential.

Parameters:
viewPasswordOption - the enumerated ViewPasswordOption value.

setOwnershipTypeName

public void setOwnershipTypeName(java.lang.String name)
Set the name of the ownership type

Parameters:
name - Ownership type name

setOwnerName

public void setOwnerName(java.lang.String namePattern)
Set the name of the owner

Parameters:
namePattern - the matching string for credential owner name The asterisk character ('*') can be used to match any string in any length (including zero length).

setOwnerBU

public void setOwnerBU(DistinguishedName bu)
Set the distinguishedName of the credential owner BU

Parameters:
the - DistinguishedName of the credential owner BU

setPoolSearchInfo

public void setPoolSearchInfo(java.lang.String value)
Set the matching string for pool name or description.

Parameters:
value - The pool name or description matching string The asterisk character ('*') can be used to match any string in any length (including zero length).

setIncludeGlobalSettingsOnly

public void setIncludeGlobalSettingsOnly(boolean globalOnly)
Indicates whether to only include credentials that use global settings



IBM Security Identity Manager 6.0.0
© Copyright International Business Machines Corporation 2007, 2012. All rights reserved. US Government Users Restricited Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.