public interface RESTResourceSchema
RESTResourceSchema
denotes the XML Schema details for the Resource
instances as below.
RESTResourceSchema
will be used in
Resource.setSchemas(Collection schemas)
for describing the schema details for the Resource.Modifier and Type | Method and Description |
---|---|
java.lang.String |
getSchemaAccessPassword()
Returns the access password for the schema if provided
|
java.lang.String |
getSchemaAccessUsername()
Retrieves the user name used for schema access authentication.
|
java.lang.String |
getSchemaFileName()
Gets the name of the schema file
|
java.lang.String |
getSchemaURL()
Retrieves the URL of the schema file.
|
boolean |
isSchemaOverwrite()
Returns whether the schema should be overwritten or newly created.
|
void |
setSchemaAccessPassword(java.lang.String schemaAccessPassword)
Sets the password required to obtain the schema files if they are uploaded from a URL.
|
void |
setSchemaAccessUsername(java.lang.String schemaAccessUsername)
Sets the user name to authenticate the schema file access.
|
void |
setSchemaFileName(java.lang.String fileName)
Sets xml schema file name
|
void |
setSchemaOverWrite(boolean isSchemaOverwrite)
Sets the option to overwrite existing schema if any.
|
void |
setSchemaURL(java.lang.String schemaURL)
Sets URL of the schema
|
void setSchemaFileName(java.lang.String fileName)
fileName
- The name of the schema filejava.lang.String getSchemaFileName()
void setSchemaURL(java.lang.String schemaURL)
schemaURL
- The schema file's URLjava.lang.String getSchemaURL()
void setSchemaAccessUsername(java.lang.String schemaAccessUsername)
schemaAccessUsername
- The user name.java.lang.String getSchemaAccessUsername()
void setSchemaAccessPassword(java.lang.String schemaAccessPassword)
schemaAccessPassword
- The password to access the schemajava.lang.String getSchemaAccessPassword()
void setSchemaOverWrite(boolean isSchemaOverwrite)
isSchemaOverwrite
- If true
, the existing schema will be overwritten
and if false
, the schema will not be overwritten.boolean isSchemaOverwrite()
true
if the schema should be overwritten and false
otherwise