|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CredentialSlotConfig
Describes the configuration of a credential slot.
Method Summary | |
---|---|
boolean |
getActive()
Deprecated. Since 8.5. |
ObjectID |
getObjectID()
Gets the credential slot's object id. |
ObjectID |
getPortalCPIID()
If this Vault Slot is user managed and portlet private (a user managed portlet private slot), this method returns the Portlet Instance ID of the portlet. |
java.lang.String |
getResourceName()
Returns the resource name for this Vault Slot. |
int |
getSecretType()
Returns the Credential Slot's Secret Type (ID). |
ObjectID |
getSegmentPortalObjectID()
Returns the Object ID of the Segment this Vault Slot belongs to. |
java.lang.String |
getSlotId()
Gets the credential slot's id. |
java.lang.String |
getVaultSlotDescription()
Returns the description for this Vault Slot in the portal default locale as specified in the portal configuration. |
java.lang.String |
getVaultSlotDescription(java.util.Locale locale)
Returns the description for this vault slot in the specified locale. |
java.util.Map<java.util.Locale,java.lang.String> |
getVaultSlotDescriptionsMap()
Returns a map of all the descriptions for this Vault Slot. |
java.lang.String |
getVaultSlotKeywords()
Returns the keywords for this Vault Slot in the portal default locale, as specified in the portal configuration. |
java.lang.String |
getVaultSlotKeywords(java.util.Locale locale)
Returns the keywords for this Vault Slot in the provided locale. |
java.util.Map<java.util.Locale,java.lang.String> |
getVaultSlotKeywordsMap()
Returns a map of all the keywords for this Vault Slot. |
boolean |
isUserManaged()
Returns if this Vault Slot is user managed or not. |
boolean |
referencesSystemCredential()
Returns if this Vault Slot references a System Credential (i.e., every access maps to the same secret). |
void |
setActive(boolean active)
Deprecated. Since 8.5. |
void |
setVaultSlotDescription(java.lang.String description)
Sets the description for this Vault Slot in the portal default locale as specified in the portal configuration. |
void |
setVaultSlotDescription(java.lang.String description,
java.util.Locale locale)
Sets a description for this vault slot in the provided locale. |
void |
setVaultSlotDescriptions(java.util.Map<java.util.Locale,java.lang.String> slotDescriptions)
Sets all the VaultSlot Descriptions. |
void |
setVaultSlotKeywords(java.util.Map<java.util.Locale,java.lang.String> slotKeywords)
Sets all the Vault Slot keywords. |
void |
setVaultSlotKeywords(java.lang.String keywords)
Sets the keywords for this Vault Slot in the portal default locale, as specified in the portal configuration. |
void |
setVaultSlotKeywords(java.lang.String keywords,
java.util.Locale locale)
Sets the keywords for this Vault Slot in the provided locale. |
Method Detail |
---|
java.lang.String getSlotId()
ObjectID getObjectID()
java.lang.String getVaultSlotDescription(java.util.Locale locale)
locale
- of the description to be returned.
The default is returned if the locale is null.
void setVaultSlotDescription(java.lang.String description, java.util.Locale locale)
description
- Translated Description. The description is set to null
if the parameter is null.locale
- The Locale the description is in; without a locale nothing is set.java.lang.String getVaultSlotDescription()
void setVaultSlotDescription(java.lang.String description)
description
- Descriptionjava.util.Map<java.util.Locale,java.lang.String> getVaultSlotDescriptionsMap()
java.util.Locale
to String
.
Map of all the descriptions for this Vault Slot, keyed by the locale.void setVaultSlotDescriptions(java.util.Map<java.util.Locale,java.lang.String> slotDescriptions)
slotDescriptions
- Descriptions as string, keyed by locale (Map from java.util.Locale
to String
.).java.lang.String getVaultSlotKeywords(java.util.Locale locale)
locale
- Locale of the keywords to be returned
If the keywords for the given locale are not available, this method
will return the keywords for the portal default
Locale, as specified in the portal configuration.
void setVaultSlotKeywords(java.lang.String keywords, java.util.Locale locale)
keywords
- Translated keywords, can be any string. If the keyword is null,
null is set as keyword.locale
- Locale of the keywords. Nothing is set, if the locale is null.java.lang.String getVaultSlotKeywords()
void setVaultSlotKeywords(java.lang.String keywords)
keywords
- java.util.Map<java.util.Locale,java.lang.String> getVaultSlotKeywordsMap()
void setVaultSlotKeywords(java.util.Map<java.util.Locale,java.lang.String> slotKeywords)
slotKeywords
- Map of all keywords, keyed by locale (Map from java.util.Locale
to String
java.lang.String getResourceName()
getSlotId()
.
ObjectID getSegmentPortalObjectID()
int getSecretType()
CredentialVaultService
class.
CredentialVaultService
boolean isUserManaged()
true
if this Vault Slot is user managed, false
if it is admin
managed.boolean referencesSystemCredential()
true
if this Vault Slot references a System Credential, false
if it references a User or Admin Credentila (non-system).ObjectID getPortalCPIID()
boolean getActive()
true
if the credential secret in this slot may only be provided in form of
an active credential object, false
otherwise.ActiveCredential
,
PassiveCredential
void setActive(boolean active)
active
- Set to true
if the credential secret in this slot may only be provided in form of an active
credential object, to false
otherwise.ActiveCredential
,
PassiveCredential
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |