com.ibm.cloud.objectstorage.auth.policy

Class PolicyReaderOptions

java.lang.Object

com.ibm.cloud.objectstorage.auth.policy.PolicyReaderOptions

public class PolicyReaderOptions
extends Object

Options that affect the way in which Policy.fromJson(String, PolicyReaderOptions) will generate a Policy.

Constructor Summary

Constructors

Constructor and Description
PolicyReaderOptions()

Method Summary

Modifier and Type	Method and Description
boolean	isStripAwsPrincipalIdHyphensEnabled() Whether AWS principal IDs should have hyphens removed in their name.
void	setStripAwsPrincipalIdHyphensEnabled(boolean stripAwsPrincipalIdHyphensEnabled) Configure whether hyphens should be stripped from the AWS principal IDs that are read from the JSON-formatted policy document.
PolicyReaderOptions	withStripAwsPrincipalIdHyphensEnabled(boolean stripAwsPrincipalIdHyphensEnabled) Fluent-style setter for setStripAwsPrincipalIdHyphensEnabled(boolean) that returns "this" for chaining.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PolicyReaderOptions

public PolicyReaderOptions()

Method Detail

isStripAwsPrincipalIdHyphensEnabled

public boolean isStripAwsPrincipalIdHyphensEnabled()

Whether AWS principal IDs should have hyphens removed in their name.

setStripAwsPrincipalIdHyphensEnabled

public void setStripAwsPrincipalIdHyphensEnabled(boolean stripAwsPrincipalIdHyphensEnabled)

Configure whether hyphens should be stripped from the AWS principal IDs that are read from the JSON-formatted policy document. This is useful because AWS account IDs must be specified without hyphens, but the user may not be aware that hyphens should not be used when configuring their policy. This behavior may be undesirable when using IAM AWS principal IDs, which may contain hyphens. In that case, this option may be explicitly disabled. If this is set to false, you must remove hyphens from your AWS principal IDs manually. By default, this is enabled (true).

withStripAwsPrincipalIdHyphensEnabled

public PolicyReaderOptions withStripAwsPrincipalIdHyphensEnabled(boolean stripAwsPrincipalIdHyphensEnabled)

Fluent-style setter for setStripAwsPrincipalIdHyphensEnabled(boolean) that returns "this" for chaining.