Class GlobalProps
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final ResourceType -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetIdps()Returns the ordered list of Identity Providers for this project.Turns the comma-separated string into a list.intReturns the Identity Provider whose security-level rules apply to unauthenticated (anonymous) Perspective sessions, exactly as configured.booleanbooleanbooleanbooleanbooleanstatic GlobalPropsCreate a newGlobalPropsinstance.static ProjectIdentityProviderNormalizes a single Identity Provider entry to the value that may be persisted: an entry that is null, or whosenameis null or blank, is treated as "none" and collapsed to null.static List<ProjectIdentityProvider> Normalizes an incoming Identity Provider list down to the entries that may be persisted, by running each throughnormalizeIdp(ProjectIdentityProvider)and dropping the entries that normalize to null (null entries, and entries with a null or blankname).voidsetAuditingEnabled(boolean auditingEnabled) voidsetAuditProfileName(String auditProfileName) voidsetAuthProfileName(String authProfileName) voidsetAutoIdpAuth(boolean autoIdpAuth) voidsetCommitMessageMode(ProjectCommitMessageMode commitMessageMode) voidsetDefaultDatasourceName(String defaultDatasourceName) voidsetDefaultSQLTagsProviderName(String defaultSqlTagsProviderName) voidsetForceIdpAuth(boolean forceIdpAuth) voidDeprecated, for removal: This API element is subject to removal in a future version.voidsetIdps(List<ProjectIdentityProvider> idps) Sets the ordered list of Identity Providers for this project.voidsetLegacyProject(boolean legacyProject) voidsetPermissionEnabled(String id, boolean enabled) voidsetPermissionEnabledMap(Map<String, Boolean> permissionEnabledMap) voidsetPublishMode(ProjectPublishMode publishMode) Deprecated.voidsetRequiredClientRoles(String id, String roles) voidsetRequiredClientRolesMap(Map<String, String> requiredClientRolesMap) voidsetRequiredCopyRoles(List<String> requiredCopyRoles) Deprecated.voidsetRequiredDeleteRoles(List<String> requiredDeleteRoles) voidsetRequiredExportRoles(List<String> requiredExportRoles) Deprecated.voidsetRequiredPublishRoles(List<String> requiredPublishRoles) Deprecated.voidsetRequiredResourceRoles(List<String> requiredResourceRoles) voidsetRequiredRoles(List<String> requiredRoles) voidsetRequiredSaveRoles(List<String> requiredSaveRoles) voidsetRequiredViewRoles(List<String> requiredViewRoles) voidsetSqltagsClientPollRate(int sqltagsClientPollRate) voidsetUnauthenticatedIdp(ProjectIdentityProvider unauthenticatedIdp) Sets the Identity Provider whose security-level rules apply to unauthenticated (anonymous) Perspective sessions.toResource(String projectName)
-
Field Details
-
MODULE_ID
- See Also:
-
RESOURCE_TYPE
-
DEF_TAG_PROVIDER_PROP
- See Also:
-
-
Constructor Details
-
GlobalProps
Deprecated.Default constructor for serialization.This should not be invoked unless by deserialization.
- See Also:
-
-
Method Details
-
newInstance
Create a newGlobalPropsinstance.- Returns:
- a new instance of
GlobalProps.
-
getDefaultDatasourceName
-
setDefaultDatasourceName
-
getDefaultSQLTagsProviderName
-
setDefaultSQLTagsProviderName
-
getAuthProfileName
-
setAuthProfileName
-
isAuditingEnabled
public boolean isAuditingEnabled() -
setAuditingEnabled
public void setAuditingEnabled(boolean auditingEnabled) -
getAuditProfileName
-
setAuditProfileName
-
getSqltagsClientPollRate
public int getSqltagsClientPollRate() -
setSqltagsClientPollRate
public void setSqltagsClientPollRate(int sqltagsClientPollRate) -
getRequiredRoles
-
setRequiredRoles
-
setCommitMessageMode
-
setRequiredPublishRoles
Deprecated. -
setPublishMode
Deprecated. -
setRequiredCopyRoles
Deprecated.The property requiredCopyRoles has been removed. This method is here to stop serialization issues. -
setRequiredExportRoles
Deprecated.The property requiredExportRoles has been removed. This method is here to stop serialization issues. -
getRequiredSaveRoles
-
setRequiredSaveRoles
-
getRequiredViewRoles
-
setRequiredViewRoles
-
getRequiredDeleteRoles
-
setRequiredDeleteRoles
-
getRequiredResourceRoles
-
setRequiredResourceRoles
-
isPermissionEnabled
-
setPermissionEnabled
-
getRequiredClientRoles
-
setRequiredClientRoles
-
setIdp
Deprecated, for removal: This API element is subject to removal in a future version.retained solely so pre-2027 single-IdP configs can still be deserialized; new configs are written toidpsviasetIdps(List).Migrates the legacy single-IdP scalar from pre-2027 project configs intoidps. This is the only place the deprecated scalar is read, and there is no corresponding getter, so the value is never re-serialized once migrated.The fold is a no-op when
idpsis already populated (i.e. a config written by 2027+ that also still carries the legacy element), so the list always wins.The name is folded in verbatim. An upgrade to 2027 starts from an 8.3 baseline, and 8.3 stores IdP names exactly as configured and resolves them by exact (case-insensitive) name, so rewriting the name here would point the project at an IdP that does not exist. Note that Perspective's
AuthChallengeActionConfigstill sanitizes its own legacy IdP reference: unlike this scalar, it serializes a version, so it can tell an 8.1-authored config (whose IdP name was sanitized when the IdP itself migrated to 8.3) from an 8.3-authored one. See IGN-16769.- Parameters:
idp- the legacy single Identity Provider name; ignored when null/blank.
-
getIdps
Returns the ordered list of Identity Providers for this project. The legacy single-IdP scalar from pre-2027 configs is folded into this list on deserialization, so it is the single canonical source.- Returns:
- the ordered list of Identity Providers for this project. never null.
-
setIdps
Sets the ordered list of Identity Providers for this project. The list is run throughnormalizeIdps(List), so callers (the config REST API, Edge project creation, the legacy-scalar migration fold, and any future config UI) cannot persist a null or nameless entry.- Parameters:
idps- the ordered list of Identity Providers; null is treated as an empty list.
-
normalizeIdps
Normalizes an incoming Identity Provider list down to the entries that may be persisted, by running each throughnormalizeIdp(ProjectIdentityProvider)and dropping the entries that normalize to null (null entries, and entries with a null or blankname). This is the single normalization applied bysetIdps(List); it is exposed so that callers comparing an incoming list against a stored (already-normalized) one can normalize both sides consistently. It also protects downstream consumers such as Perspective, which flattens this list to names and rejects null elements.- Parameters:
idps- the raw Identity Provider list; null is treated as an empty list.- Returns:
- a new mutable list containing only the named entries, in their original order. never null.
-
getUnauthenticatedIdp
Returns the Identity Provider whose security-level rules apply to unauthenticated (anonymous) Perspective sessions, exactly as configured. It does not have to be one of this project'sIdPs, and there is no fallback: when no unauthenticated IdP has been explicitly configured this returns null, and anonymous sessions are granted no IdP-based security levels.- Returns:
- the configured unauthenticated-user Identity Provider, or null if none is set.
-
setUnauthenticatedIdp
Sets the Identity Provider whose security-level rules apply to unauthenticated (anonymous) Perspective sessions. It need not be one of this project'sIdPs. The value is run throughnormalizeIdp(ProjectIdentityProvider), so a null or blank-named entry is stored as null ("no fallback") rather than an unmatchable nameless IdP.- Parameters:
unauthenticatedIdp- the unauthenticated-user Identity Provider; may be null.
-
normalizeIdp
Normalizes a single Identity Provider entry to the value that may be persisted: an entry that is null, or whosenameis null or blank, is treated as "none" and collapsed to null. This is the single definition of a valid IdP entry:setUnauthenticatedIdp(ProjectIdentityProvider)applies it to the unauthenticated scalar (so it round-trips withgetUnauthenticatedIdp(), which returns null when unset and applies no fallback), andnormalizeIdps(List)applies it per element. It is exposed so that callers comparing an incoming value against a stored (already-normalized) one can normalize both sides consistently.- Parameters:
idp- the raw Identity Provider entry; may be null.- Returns:
- the entry when it carries a non-blank name, otherwise null.
-
isForceIdpAuth
public boolean isForceIdpAuth() -
setForceIdpAuth
public void setForceIdpAuth(boolean forceIdpAuth) -
isAutoIdpAuth
public boolean isAutoIdpAuth() -
setAutoIdpAuth
public void setAutoIdpAuth(boolean autoIdpAuth) -
getPermissionEnabledMap
-
setPermissionEnabledMap
-
getRequiredClientRolesMap
-
setRequiredClientRolesMap
-
isLegacyProject
public boolean isLegacyProject() -
setLegacyProject
public void setLegacyProject(boolean legacyProject) -
getRequiredClientRolesAsList
Turns the comma-separated string into a list. Does its best to decipher zone/role if included- Parameters:
id- Permissions id- Returns:
- Required client zone/roles as list. Not null.
-
toResource
-
idpsviasetIdps(List).