Modifier and Type	Class and Description
private static class	Services.BasicService
public static class	Services.ServiceBuilder

Modifier and Type	Field and Description
private static final Logger	LOG
private static final Map<String, String>	REALM_SPECIFIC_ENDPOINT_TEMPLATE_MAP
private static final Map<String, Service>	SERVICE_CACHE

Access	Constructor and Description
public	Services()

Modifier and Type	Method and Description
public static Service	Returns: A Service instance. create(final String The unique service name. serviceName, final String The endpoint prefix. serviceEndpointPrefix) Deprecated Use `serviceBuilder()` instead Create a new service definition.
private static synchronized Service	create(final String serviceName, final String serviceEndpointPrefix, final String serviceEndpointTemplate, final String endpointServiceName)
public static Service	Returns: service instance getServiceByName(final String service name should be UPPER CASE. serviceName) Get Service instance based on service name.
public static Services.ServiceBuilder	serviceBuilder()

LOG	back to summary
private static final Logger LOG

REALM_SPECIFIC_ENDPOINT_TEMPLATE_MAP	back to summary
private static final Map<String, String> REALM_SPECIFIC_ENDPOINT_TEMPLATE_MAP

SERVICE_CACHE	back to summary
private static final Map<String, Service> SERVICE_CACHE

Services	back to summary
public Services()

create	back to summary
public static Service create(final String serviceName, final String serviceEndpointPrefix) Deprecated Use `serviceBuilder()` instead Create a new service definition. If the service has already been registered with different values, an IllegalArgumentException will be raised. If the service has already been registered, the existing definition will be returned. Parameters serviceName:String The unique service name. serviceEndpointPrefix:String The endpoint prefix. Returns:Service A Service instance. Annotations @Deprecated

create	back to summary
private static synchronized Service create(final String serviceName, final String serviceEndpointPrefix, final String serviceEndpointTemplate, final String endpointServiceName)

getServiceByName	back to summary
public static Service getServiceByName(final String serviceName) Get Service instance based on service name. Parameters serviceName:String service name should be UPPER CASE. Returns:Service service instance

serviceBuilder	back to summary
public static Services.ServiceBuilder serviceBuilder()

private final Class Services.BasicService

Class Inheritance

extends Object
implements Service

java.lang.Object
com.oracle.bmc.Services.BasicService

All Implemented Interfaces

com.oracle.bmc.Service

Field Summary

Modifier and Type	Field and Description
private final String	endpointServiceName
private final String	serviceEndpointPrefix
private final String	serviceEndpointTemplate
private final String	serviceName

Constructor Summary

Access	Constructor and Description
public	BasicService(String serviceName, String serviceEndpointPrefix, String serviceEndpointTemplate, String endpointServiceName)

Method Summary

Modifier and Type	Method and Description
public void	addServiceEndpointTemplateForRealm(String Key in the map realmId, String Value in the map endpoint) Implements com.oracle.bmc.Service.addServiceEndpointTemplateForRealm. This method adds service endpoint templates for the realm to a map
public boolean	equals(final Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getEndpointServiceName() Implements com.oracle.bmc.Service.getEndpointServiceName. The service endpoint name that will be used only for dotted regions if set by the service.
public String	getServiceEndpointPrefix() Implements com.oracle.bmc.Service.getServiceEndpointPrefix. The service endpoint prefix that will be used, ex "iaas" for "https://iaas.us-phoenix-1.oraclecloud.com".
public String	getServiceEndpointTemplate() Implements com.oracle.bmc.Service.getServiceEndpointTemplate. The service endpoint template that will be used, ex "{serviceEndpointPrefix}.{region}.service.oci.oraclecloud.com".
public Map<String, String>	getServiceEndpointTemplateForRealmMap() Implements com.oracle.bmc.Service.getServiceEndpointTemplateForRealmMap. The map of all realm-specific service endpoint templates with realmId as key and endpoint template for corresponding realmId as the value ex "oc1={serviceParameter}{serviceEndpointPrefix}.{region}.{serviceSecondLevelDomain}".
public String	getServiceName() Implements com.oracle.bmc.Service.getServiceName. The unique service name, ex "BLOCKSTORAGE".
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

endpointServiceName	back to summary
private final String endpointServiceName

serviceEndpointPrefix	back to summary
private final String serviceEndpointPrefix

serviceEndpointTemplate	back to summary
private final String serviceEndpointTemplate

serviceName	back to summary
private final String serviceName

Constructor Detail

BasicService	back to summary
public BasicService(String serviceName, String serviceEndpointPrefix, String serviceEndpointTemplate, String endpointServiceName) Annotations @java.beans.ConstructorProperties

Method Detail

addServiceEndpointTemplateForRealm	back to summary
public void addServiceEndpointTemplateForRealm(String realmId, String endpoint) Implements com.oracle.bmc.Service.addServiceEndpointTemplateForRealm. Doc from com.oracle.bmc.Service.addServiceEndpointTemplateForRealm. This method adds service endpoint templates for the realm to a map Parameters realmId:String Key in the map endpoint:String Value in the map

addServiceEndpointTemplateForRealm

back to summary

public void addServiceEndpointTemplateForRealm(String realmId, String endpoint)

Implements com.oracle.bmc.Service.addServiceEndpointTemplateForRealm.

Doc from com.oracle.bmc.Service.addServiceEndpointTemplateForRealm.

This method adds service endpoint templates for the realm to a map

Parameters

realmId:String: Key in the map
endpoint:String: Value in the map

equals back to summary

equals	back to summary
public boolean equals(final Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise.

public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

getEndpointServiceName	back to summary
public String getEndpointServiceName() Implements com.oracle.bmc.Service.getEndpointServiceName. Doc from com.oracle.bmc.Service.getEndpointServiceName. The service endpoint name that will be used only for dotted regions if set by the service. {service} in "https://{service}.{region}". The service endpoint template (if specified) will be ignored in this case.

getEndpointServiceName

back to summary

public String getEndpointServiceName()

Implements com.oracle.bmc.Service.getEndpointServiceName.

Doc from com.oracle.bmc.Service.getEndpointServiceName.

The service endpoint name that will be used only for dotted regions if set by the service. {service} in "https://{service}.{region}". The service endpoint template (if specified) will be ignored in this case.

getServiceEndpointPrefix	back to summary
public String getServiceEndpointPrefix() Implements com.oracle.bmc.Service.getServiceEndpointPrefix. Doc from com.oracle.bmc.Service.getServiceEndpointPrefix. The service endpoint prefix that will be used, ex "iaas" for "https://iaas.us-phoenix-1.oraclecloud.com".

getServiceEndpointPrefix

back to summary

public String getServiceEndpointPrefix()

Implements com.oracle.bmc.Service.getServiceEndpointPrefix.

Doc from com.oracle.bmc.Service.getServiceEndpointPrefix.

The service endpoint prefix that will be used, ex "iaas" for "https://iaas.us-phoenix-1.oraclecloud.com".

getServiceEndpointTemplate back to summary

getServiceEndpointTemplate	back to summary
public String getServiceEndpointTemplate() Implements com.oracle.bmc.Service.getServiceEndpointTemplate. Doc from com.oracle.bmc.Service.getServiceEndpointTemplate. The service endpoint template that will be used, ex "{serviceEndpointPrefix}.{region}.service.oci.oraclecloud.com". This overrides the template used in `DefaultEndpointConfiguration`, but can still use the same variables.

public String getServiceEndpointTemplate()

Implements com.oracle.bmc.Service.getServiceEndpointTemplate.

Doc from com.oracle.bmc.Service.getServiceEndpointTemplate.

The service endpoint template that will be used, ex "{serviceEndpointPrefix}.{region}.service.oci.oraclecloud.com".

This overrides the template used in DefaultEndpointConfiguration, but can still use the same variables.

getServiceEndpointTemplateForRealmMap back to summary

getServiceEndpointTemplateForRealmMap	back to summary
public Map<String, String> getServiceEndpointTemplateForRealmMap() Implements com.oracle.bmc.Service.getServiceEndpointTemplateForRealmMap. Doc from com.oracle.bmc.Service.getServiceEndpointTemplateForRealmMap. The map of all realm-specific service endpoint templates with realmId as key and endpoint template for corresponding realmId as the value ex "oc1={serviceParameter}{serviceEndpointPrefix}.{region}.{serviceSecondLevelDomain}". This overrides the template used in `DefaultEndpointConfiguration`, but can still use the same variables.

public Map<String, String> getServiceEndpointTemplateForRealmMap()

Implements com.oracle.bmc.Service.getServiceEndpointTemplateForRealmMap.

Doc from com.oracle.bmc.Service.getServiceEndpointTemplateForRealmMap.

The map of all realm-specific service endpoint templates with realmId as key and endpoint template for corresponding realmId as the value ex "oc1={serviceParameter}{serviceEndpointPrefix}.{region}.{serviceSecondLevelDomain}".

This overrides the template used in DefaultEndpointConfiguration, but can still use the same variables.

getServiceName	back to summary
public String getServiceName() Implements com.oracle.bmc.Service.getServiceName. Doc from com.oracle.bmc.Service.getServiceName. The unique service name, ex "BLOCKSTORAGE". Must not be null.

getServiceName

back to summary

public String getServiceName()

Implements com.oracle.bmc.Service.getServiceName.

Doc from com.oracle.bmc.Service.getServiceName.

The unique service name, ex "BLOCKSTORAGE". Must not be null.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int: a hash code value for this object

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

com.oracle.bmc back to summary

public Class Services.ServiceBuilder

Class Inheritance

extends Object

java.lang.Object
com.oracle.bmc.Services.ServiceBuilder

Field Summary

Modifier and Type	Field and Description
private String	endpointServiceName
private String	serviceEndpointPrefix
private String	serviceEndpointTemplate
private String	serviceName

Constructor Summary

Access	Constructor and Description
pack-priv	ServiceBuilder()

Method Summary

Modifier and Type	Method and Description
public Services.ServiceBuilder	addServiceEndpointTemplateForRealm(String realmId, String endpoint)
public Service	build()
public Services.ServiceBuilder	endpointServiceName(String endpointServiceName)
public Services.ServiceBuilder	serviceEndpointPrefix(String serviceEndpointPrefix)
public Services.ServiceBuilder	serviceEndpointTemplate(String serviceEndpointTemplate)
public Services.ServiceBuilder	serviceName(String serviceName)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

endpointServiceName	back to summary
private String endpointServiceName

serviceEndpointPrefix	back to summary
private String serviceEndpointPrefix

serviceEndpointTemplate	back to summary
private String serviceEndpointTemplate

serviceName	back to summary
private String serviceName

Constructor Detail

ServiceBuilder	back to summary
pack-priv ServiceBuilder()

Method Detail

addServiceEndpointTemplateForRealm	back to summary
public Services.ServiceBuilder addServiceEndpointTemplateForRealm(String realmId, String endpoint)

build	back to summary
public Service build()

endpointServiceName	back to summary
public Services.ServiceBuilder endpointServiceName(String endpointServiceName)

serviceEndpointPrefix	back to summary
public Services.ServiceBuilder serviceEndpointPrefix(String serviceEndpointPrefix)

serviceEndpointTemplate	back to summary
public Services.ServiceBuilder serviceEndpointTemplate(String serviceEndpointTemplate)

serviceName	back to summary
public Services.ServiceBuilder serviceName(String serviceName)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

public Class Services

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class Services.BasicService

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Services.ServiceBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail