Package com.contentstack.sdk
Class Config
- java.lang.Object
-
- com.contentstack.sdk.Config
-
public class Config extends Object
MIT License Copyright (c) 2012 - 2019 Contentstack Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classConfig.ContentstackRegion
-
Field Summary
Fields Modifier and Type Field Description protected Stringenvironmentprotected Config.ContentstackRegionregionprotected StringURLprotected StringURLSCHEMAprotected StringVERSION
-
Constructor Summary
Constructors Constructor Description Config()Config constructor
Example :
-
Method Summary
Modifier and Type Method Description StringgetEnvironment()Get environment.StringgetHost()Config.ContentstackRegiongetRegion()StringgetVersion()Get version of the Contentstack server.protected voidsetEnvironment(String environment)set environment.voidsetHost(String hostName)Sets host name of the Contentstack server.Config.ContentstackRegionsetRegion(Config.ContentstackRegion region)Sets region allow you to set your region for the Contentstack server.
-
-
-
Field Detail
-
URLSCHEMA
protected String URLSCHEMA
-
URL
protected String URL
-
VERSION
protected String VERSION
-
environment
protected String environment
-
region
protected Config.ContentstackRegion region
-
-
Method Detail
-
getRegion
public Config.ContentstackRegion getRegion()
-
setRegion
public Config.ContentstackRegion setRegion(Config.ContentstackRegion region)
Sets region allow you to set your region for the Contentstack server.- Parameters:
region- typeConfig.ContentstackRegion- Returns:
- ContentstackRegion
Note: Default region sets to us
Example :
config.setRegion(ContentstackRegion.US);
-
setHost
public void setHost(String hostName)
Sets host name of the Contentstack server.- Parameters:
hostName- host name.Note: Default hostname sets to cdn.contentstack.io and default protocol is HTTPS.
Example :
config.setHost("cdn.contentstack.io");
-
getHost
public String getHost()
- Returns:
- URL String
Example :
String url = config.getHost();
-
getVersion
public String getVersion()
Get version of the Contentstack server.- Returns:
- VERSION String
Example :
String version = config.getVersion();
-
setEnvironment
protected void setEnvironment(String environment)
set environment.- Parameters:
environment- uid/name
Example :
config.setEnvironment("stag", false);
-
getEnvironment
public String getEnvironment()
Get environment.- Returns:
- param environment string
Example :
String environment = config.getEnvironment();
-
-