com.cyberark.conjur.api

Class Endpoints

java.lang.Object

com.cyberark.conjur.api.Endpoints

All Implemented Interfaces:

Serializable

public class Endpoints
extends Object
implements Serializable

An Endpoints instance provides endpoint URIs for the various Conjur services.

Preferred construction is via fromSystemProperties() or fromCredentials(Credentials). These paths derive service URIs from an appliance URL and account name:

• Authentication: {applianceUrl}/authn/{account}
• Secrets (single): {applianceUrl}/secrets/{account}/variable
• Secrets (batch): {applianceUrl}/secrets
• Resources: {applianceUrl}/resources/{account}

For non-standard authenticators (LDAP, OIDC, etc.), supply a custom authn URL.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Endpoints(String authnUri, String secretsUri) Deprecated. Use factory methods for new code: fromSystemProperties() or fromCredentials(Credentials).
Endpoints(URI authnUri, URI secretsUri) Deprecated. Use factory methods for new code: fromSystemProperties() or fromCredentials(Credentials).

Method Summary

Modifier and Type	Method and Description
static Endpoints	fromCredentials(Credentials credentials) Creates endpoints using the account/appliance values from configuration and the authenticator URL from the provided credentials.
static Endpoints	fromSystemProperties() Creates endpoints from system properties / environment variables.
String	getAccount() Returns the Conjur account name associated with these endpoints.
URI	getAuthnUri()
URI	getBatchSecretsUri() Returns the base URI for batch secret retrieval: {applianceUrl}/secrets
URI	getResourcesUri() Returns the URI for listing resources: {applianceUrl}/resources/{account}
URI	getSecretsUri()
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Endpoints

@Deprecated
public Endpoints(URI authnUri,
                             URI secretsUri)

Deprecated. Use factory methods for new code: fromSystemProperties() or fromCredentials(Credentials).

Constructs endpoints from fully-qualified authn and secrets URIs.

This legacy constructor preserves only the explicitly supplied authn and secrets URIs. It does not initialize derived state needed by newer APIs, such as batch secret retrieval. Use the factory methods for fully initialized endpoint instances.

Parameters:

authnUri - the authn service URI

secretsUri - the secrets service URI

Endpoints

@Deprecated
public Endpoints(String authnUri,
                             String secretsUri)

Deprecated. Use factory methods for new code: fromSystemProperties() or fromCredentials(Credentials).

Constructs endpoints from fully-qualified authn and secrets URI strings.

This legacy constructor preserves only the explicitly supplied authn and secrets URIs. It does not initialize derived state needed by newer APIs, such as batch secret retrieval. Use the factory methods for fully initialized endpoint instances.

Parameters:

authnUri - the authn service URI string

secretsUri - the secrets service URI string

Method Detail

getAuthnUri

public URI getAuthnUri()

getSecretsUri

public URI getSecretsUri()

getAccount

public String getAccount()

Returns the Conjur account name associated with these endpoints.

Returns:

the configured Conjur account name

Throws:

IllegalStateException - when account is unavailable on this instance

getBatchSecretsUri

public URI getBatchSecretsUri()

Returns the base URI for batch secret retrieval: {applianceUrl}/secrets

Returns:

the batch secrets URI

Throws:

IllegalStateException - when appliance URL is unavailable on this instance

getResourcesUri

public URI getResourcesUri()

Returns the URI for listing resources: {applianceUrl}/resources/{account}

Returns:

the resources URI

fromSystemProperties

public static Endpoints fromSystemProperties()

Creates endpoints from system properties / environment variables.

Reads the following configuration values:

• CONJUR_ACCOUNT (required)
• CONJUR_APPLIANCE_URL (required)
• CONJUR_AUTHN_URL (optional, defaults to {applianceUrl}/authn)

Returns:

an Endpoints instance derived from configured Conjur settings

Throws:

IllegalArgumentException - if required configuration is missing

fromCredentials

public static Endpoints fromCredentials(Credentials credentials)

Creates endpoints using the account/appliance values from configuration and the authenticator URL from the provided credentials.

Reads the following configuration values:

• CONJUR_ACCOUNT (required)
• CONJUR_APPLIANCE_URL (required)

Parameters:

credentials - credentials whose authnUrl is used to build the authn endpoint

Returns:

an Endpoints instance combining configured account/appliance with the provided authn URL

Throws:

IllegalArgumentException - if required configuration is missing

toString

public String toString()

Overrides:

toString in class Object