You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airavata.apache.org by sc...@apache.org on 2016/10/16 22:26:27 UTC
[45/51] [abbrv] airavata git commit: adding initial how to use
documents
http://git-wip-us.apache.org/repos/asf/airavata/blob/61a0fc95/modules/sharing-registry/sharing-registry-stubs/src/main/java/org/apache/airavata/sharing/registry/service/cpi/SharingRegistryService.java
----------------------------------------------------------------------
diff --git a/modules/sharing-registry/sharing-registry-stubs/src/main/java/org/apache/airavata/sharing/registry/service/cpi/SharingRegistryService.java b/modules/sharing-registry/sharing-registry-stubs/src/main/java/org/apache/airavata/sharing/registry/service/cpi/SharingRegistryService.java
index 7605f82..25ab01a 100644
--- a/modules/sharing-registry/sharing-registry-stubs/src/main/java/org/apache/airavata/sharing/registry/service/cpi/SharingRegistryService.java
+++ b/modules/sharing-registry/sharing-registry-stubs/src/main/java/org/apache/airavata/sharing/registry/service/cpi/SharingRegistryService.java
@@ -42,16 +42,16 @@ public class SharingRegistryService {
/**
* <p>API method to create a new domain</p>
*
- * @param domainId
+ * @param domain
*/
- public String createDomain(org.apache.airavata.sharing.registry.models.Domain domainId) throws org.apache.airavata.sharing.registry.models.SharingRegistryException, org.apache.thrift.TException;
+ public String createDomain(org.apache.airavata.sharing.registry.models.Domain domain) throws org.apache.airavata.sharing.registry.models.SharingRegistryException, org.apache.thrift.TException;
/**
* <p>API method to update a domain</p>
*
- * @param domainId
+ * @param domain
*/
- public boolean updateDomain(org.apache.airavata.sharing.registry.models.Domain domainId) throws org.apache.airavata.sharing.registry.models.SharingRegistryException, org.apache.thrift.TException;
+ public boolean updateDomain(org.apache.airavata.sharing.registry.models.Domain domain) throws org.apache.airavata.sharing.registry.models.SharingRegistryException, org.apache.thrift.TException;
/**
* <p>API method to delete domain</p>
@@ -387,9 +387,9 @@ public class SharingRegistryService {
public interface AsyncIface {
- public void createDomain(org.apache.airavata.sharing.registry.models.Domain domainId, org.apache.thrift.async.AsyncMethodCallback resultHandler) throws org.apache.thrift.TException;
+ public void createDomain(org.apache.airavata.sharing.registry.models.Domain domain, org.apache.thrift.async.AsyncMethodCallback resultHandler) throws org.apache.thrift.TException;
- public void updateDomain(org.apache.airavata.sharing.registry.models.Domain domainId, org.apache.thrift.async.AsyncMethodCallback resultHandler) throws org.apache.thrift.TException;
+ public void updateDomain(org.apache.airavata.sharing.registry.models.Domain domain, org.apache.thrift.async.AsyncMethodCallback resultHandler) throws org.apache.thrift.TException;
public void deleteDomain(String domainId, org.apache.thrift.async.AsyncMethodCallback resultHandler) throws org.apache.thrift.TException;
@@ -495,16 +495,16 @@ public class SharingRegistryService {
super(iprot, oprot);
}
- public String createDomain(org.apache.airavata.sharing.registry.models.Domain domainId) throws org.apache.airavata.sharing.registry.models.SharingRegistryException, org.apache.thrift.TException
+ public String createDomain(org.apache.airavata.sharing.registry.models.Domain domain) throws org.apache.airavata.sharing.registry.models.SharingRegistryException, org.apache.thrift.TException
{
- send_createDomain(domainId);
+ send_createDomain(domain);
return recv_createDomain();
}
- public void send_createDomain(org.apache.airavata.sharing.registry.models.Domain domainId) throws org.apache.thrift.TException
+ public void send_createDomain(org.apache.airavata.sharing.registry.models.Domain domain) throws org.apache.thrift.TException
{
createDomain_args args = new createDomain_args();
- args.setDomainId(domainId);
+ args.setDomain(domain);
sendBase("createDomain", args);
}
@@ -521,16 +521,16 @@ public class SharingRegistryService {
throw new org.apache.thrift.TApplicationException(org.apache.thrift.TApplicationException.MISSING_RESULT, "createDomain failed: unknown result");
}
- public boolean updateDomain(org.apache.airavata.sharing.registry.models.Domain domainId) throws org.apache.airavata.sharing.registry.models.SharingRegistryException, org.apache.thrift.TException
+ public boolean updateDomain(org.apache.airavata.sharing.registry.models.Domain domain) throws org.apache.airavata.sharing.registry.models.SharingRegistryException, org.apache.thrift.TException
{
- send_updateDomain(domainId);
+ send_updateDomain(domain);
return recv_updateDomain();
}
- public void send_updateDomain(org.apache.airavata.sharing.registry.models.Domain domainId) throws org.apache.thrift.TException
+ public void send_updateDomain(org.apache.airavata.sharing.registry.models.Domain domain) throws org.apache.thrift.TException
{
updateDomain_args args = new updateDomain_args();
- args.setDomainId(domainId);
+ args.setDomain(domain);
sendBase("updateDomain", args);
}
@@ -1668,24 +1668,24 @@ public class SharingRegistryService {
super(protocolFactory, clientManager, transport);
}
- public void createDomain(org.apache.airavata.sharing.registry.models.Domain domainId, org.apache.thrift.async.AsyncMethodCallback resultHandler) throws org.apache.thrift.TException {
+ public void createDomain(org.apache.airavata.sharing.registry.models.Domain domain, org.apache.thrift.async.AsyncMethodCallback resultHandler) throws org.apache.thrift.TException {
checkReady();
- createDomain_call method_call = new createDomain_call(domainId, resultHandler, this, ___protocolFactory, ___transport);
+ createDomain_call method_call = new createDomain_call(domain, resultHandler, this, ___protocolFactory, ___transport);
this.___currentMethod = method_call;
___manager.call(method_call);
}
public static class createDomain_call extends org.apache.thrift.async.TAsyncMethodCall {
- private org.apache.airavata.sharing.registry.models.Domain domainId;
- public createDomain_call(org.apache.airavata.sharing.registry.models.Domain domainId, org.apache.thrift.async.AsyncMethodCallback resultHandler, org.apache.thrift.async.TAsyncClient client, org.apache.thrift.protocol.TProtocolFactory protocolFactory, org.apache.thrift.transport.TNonblockingTransport transport) throws org.apache.thrift.TException {
+ private org.apache.airavata.sharing.registry.models.Domain domain;
+ public createDomain_call(org.apache.airavata.sharing.registry.models.Domain domain, org.apache.thrift.async.AsyncMethodCallback resultHandler, org.apache.thrift.async.TAsyncClient client, org.apache.thrift.protocol.TProtocolFactory protocolFactory, org.apache.thrift.transport.TNonblockingTransport transport) throws org.apache.thrift.TException {
super(client, protocolFactory, transport, resultHandler, false);
- this.domainId = domainId;
+ this.domain = domain;
}
public void write_args(org.apache.thrift.protocol.TProtocol prot) throws org.apache.thrift.TException {
prot.writeMessageBegin(new org.apache.thrift.protocol.TMessage("createDomain", org.apache.thrift.protocol.TMessageType.CALL, 0));
createDomain_args args = new createDomain_args();
- args.setDomainId(domainId);
+ args.setDomain(domain);
args.write(prot);
prot.writeMessageEnd();
}
@@ -1700,24 +1700,24 @@ public class SharingRegistryService {
}
}
- public void updateDomain(org.apache.airavata.sharing.registry.models.Domain domainId, org.apache.thrift.async.AsyncMethodCallback resultHandler) throws org.apache.thrift.TException {
+ public void updateDomain(org.apache.airavata.sharing.registry.models.Domain domain, org.apache.thrift.async.AsyncMethodCallback resultHandler) throws org.apache.thrift.TException {
checkReady();
- updateDomain_call method_call = new updateDomain_call(domainId, resultHandler, this, ___protocolFactory, ___transport);
+ updateDomain_call method_call = new updateDomain_call(domain, resultHandler, this, ___protocolFactory, ___transport);
this.___currentMethod = method_call;
___manager.call(method_call);
}
public static class updateDomain_call extends org.apache.thrift.async.TAsyncMethodCall {
- private org.apache.airavata.sharing.registry.models.Domain domainId;
- public updateDomain_call(org.apache.airavata.sharing.registry.models.Domain domainId, org.apache.thrift.async.AsyncMethodCallback resultHandler, org.apache.thrift.async.TAsyncClient client, org.apache.thrift.protocol.TProtocolFactory protocolFactory, org.apache.thrift.transport.TNonblockingTransport transport) throws org.apache.thrift.TException {
+ private org.apache.airavata.sharing.registry.models.Domain domain;
+ public updateDomain_call(org.apache.airavata.sharing.registry.models.Domain domain, org.apache.thrift.async.AsyncMethodCallback resultHandler, org.apache.thrift.async.TAsyncClient client, org.apache.thrift.protocol.TProtocolFactory protocolFactory, org.apache.thrift.transport.TNonblockingTransport transport) throws org.apache.thrift.TException {
super(client, protocolFactory, transport, resultHandler, false);
- this.domainId = domainId;
+ this.domain = domain;
}
public void write_args(org.apache.thrift.protocol.TProtocol prot) throws org.apache.thrift.TException {
prot.writeMessageBegin(new org.apache.thrift.protocol.TMessage("updateDomain", org.apache.thrift.protocol.TMessageType.CALL, 0));
updateDomain_args args = new updateDomain_args();
- args.setDomainId(domainId);
+ args.setDomain(domain);
args.write(prot);
prot.writeMessageEnd();
}
@@ -3239,7 +3239,7 @@ public class SharingRegistryService {
public createDomain_result getResult(I iface, createDomain_args args) throws org.apache.thrift.TException {
createDomain_result result = new createDomain_result();
try {
- result.success = iface.createDomain(args.domainId);
+ result.success = iface.createDomain(args.domain);
} catch (org.apache.airavata.sharing.registry.models.SharingRegistryException sre) {
result.sre = sre;
}
@@ -3263,7 +3263,7 @@ public class SharingRegistryService {
public updateDomain_result getResult(I iface, updateDomain_args args) throws org.apache.thrift.TException {
updateDomain_result result = new updateDomain_result();
try {
- result.success = iface.updateDomain(args.domainId);
+ result.success = iface.updateDomain(args.domain);
result.setSuccessIsSet(true);
} catch (org.apache.airavata.sharing.registry.models.SharingRegistryException sre) {
result.sre = sre;
@@ -4384,7 +4384,7 @@ public class SharingRegistryService {
}
public void start(I iface, createDomain_args args, org.apache.thrift.async.AsyncMethodCallback<String> resultHandler) throws TException {
- iface.createDomain(args.domainId,resultHandler);
+ iface.createDomain(args.domain,resultHandler);
}
}
@@ -4442,7 +4442,7 @@ public class SharingRegistryService {
}
public void start(I iface, updateDomain_args args, org.apache.thrift.async.AsyncMethodCallback<Boolean> resultHandler) throws TException {
- iface.updateDomain(args.domainId,resultHandler);
+ iface.updateDomain(args.domain,resultHandler);
}
}
@@ -6802,7 +6802,7 @@ public class SharingRegistryService {
public static class createDomain_args implements org.apache.thrift.TBase<createDomain_args, createDomain_args._Fields>, java.io.Serializable, Cloneable, Comparable<createDomain_args> {
private static final org.apache.thrift.protocol.TStruct STRUCT_DESC = new org.apache.thrift.protocol.TStruct("createDomain_args");
- private static final org.apache.thrift.protocol.TField DOMAIN_ID_FIELD_DESC = new org.apache.thrift.protocol.TField("domainId", org.apache.thrift.protocol.TType.STRUCT, (short)1);
+ private static final org.apache.thrift.protocol.TField DOMAIN_FIELD_DESC = new org.apache.thrift.protocol.TField("domain", org.apache.thrift.protocol.TType.STRUCT, (short)1);
private static final Map<Class<? extends IScheme>, SchemeFactory> schemes = new HashMap<Class<? extends IScheme>, SchemeFactory>();
static {
@@ -6810,11 +6810,11 @@ public class SharingRegistryService {
schemes.put(TupleScheme.class, new createDomain_argsTupleSchemeFactory());
}
- public org.apache.airavata.sharing.registry.models.Domain domainId; // required
+ public org.apache.airavata.sharing.registry.models.Domain domain; // required
/** The set of fields this struct contains, along with convenience methods for finding and manipulating them. */
public enum _Fields implements org.apache.thrift.TFieldIdEnum {
- DOMAIN_ID((short)1, "domainId");
+ DOMAIN((short)1, "domain");
private static final Map<String, _Fields> byName = new HashMap<String, _Fields>();
@@ -6829,8 +6829,8 @@ public class SharingRegistryService {
*/
public static _Fields findByThriftId(int fieldId) {
switch(fieldId) {
- case 1: // DOMAIN_ID
- return DOMAIN_ID;
+ case 1: // DOMAIN
+ return DOMAIN;
default:
return null;
}
@@ -6874,7 +6874,7 @@ public class SharingRegistryService {
public static final Map<_Fields, org.apache.thrift.meta_data.FieldMetaData> metaDataMap;
static {
Map<_Fields, org.apache.thrift.meta_data.FieldMetaData> tmpMap = new EnumMap<_Fields, org.apache.thrift.meta_data.FieldMetaData>(_Fields.class);
- tmpMap.put(_Fields.DOMAIN_ID, new org.apache.thrift.meta_data.FieldMetaData("domainId", org.apache.thrift.TFieldRequirementType.REQUIRED,
+ tmpMap.put(_Fields.DOMAIN, new org.apache.thrift.meta_data.FieldMetaData("domain", org.apache.thrift.TFieldRequirementType.REQUIRED,
new org.apache.thrift.meta_data.StructMetaData(org.apache.thrift.protocol.TType.STRUCT, org.apache.airavata.sharing.registry.models.Domain.class)));
metaDataMap = Collections.unmodifiableMap(tmpMap);
org.apache.thrift.meta_data.FieldMetaData.addStructMetaDataMap(createDomain_args.class, metaDataMap);
@@ -6884,18 +6884,18 @@ public class SharingRegistryService {
}
public createDomain_args(
- org.apache.airavata.sharing.registry.models.Domain domainId)
+ org.apache.airavata.sharing.registry.models.Domain domain)
{
this();
- this.domainId = domainId;
+ this.domain = domain;
}
/**
* Performs a deep copy on <i>other</i>.
*/
public createDomain_args(createDomain_args other) {
- if (other.isSetDomainId()) {
- this.domainId = new org.apache.airavata.sharing.registry.models.Domain(other.domainId);
+ if (other.isSetDomain()) {
+ this.domain = new org.apache.airavata.sharing.registry.models.Domain(other.domain);
}
}
@@ -6905,40 +6905,40 @@ public class SharingRegistryService {
@Override
public void clear() {
- this.domainId = null;
+ this.domain = null;
}
- public org.apache.airavata.sharing.registry.models.Domain getDomainId() {
- return this.domainId;
+ public org.apache.airavata.sharing.registry.models.Domain getDomain() {
+ return this.domain;
}
- public createDomain_args setDomainId(org.apache.airavata.sharing.registry.models.Domain domainId) {
- this.domainId = domainId;
+ public createDomain_args setDomain(org.apache.airavata.sharing.registry.models.Domain domain) {
+ this.domain = domain;
return this;
}
- public void unsetDomainId() {
- this.domainId = null;
+ public void unsetDomain() {
+ this.domain = null;
}
- /** Returns true if field domainId is set (has been assigned a value) and false otherwise */
- public boolean isSetDomainId() {
- return this.domainId != null;
+ /** Returns true if field domain is set (has been assigned a value) and false otherwise */
+ public boolean isSetDomain() {
+ return this.domain != null;
}
- public void setDomainIdIsSet(boolean value) {
+ public void setDomainIsSet(boolean value) {
if (!value) {
- this.domainId = null;
+ this.domain = null;
}
}
public void setFieldValue(_Fields field, Object value) {
switch (field) {
- case DOMAIN_ID:
+ case DOMAIN:
if (value == null) {
- unsetDomainId();
+ unsetDomain();
} else {
- setDomainId((org.apache.airavata.sharing.registry.models.Domain)value);
+ setDomain((org.apache.airavata.sharing.registry.models.Domain)value);
}
break;
@@ -6947,8 +6947,8 @@ public class SharingRegistryService {
public Object getFieldValue(_Fields field) {
switch (field) {
- case DOMAIN_ID:
- return getDomainId();
+ case DOMAIN:
+ return getDomain();
}
throw new IllegalStateException();
@@ -6961,8 +6961,8 @@ public class SharingRegistryService {
}
switch (field) {
- case DOMAIN_ID:
- return isSetDomainId();
+ case DOMAIN:
+ return isSetDomain();
}
throw new IllegalStateException();
}
@@ -6980,12 +6980,12 @@ public class SharingRegistryService {
if (that == null)
return false;
- boolean this_present_domainId = true && this.isSetDomainId();
- boolean that_present_domainId = true && that.isSetDomainId();
- if (this_present_domainId || that_present_domainId) {
- if (!(this_present_domainId && that_present_domainId))
+ boolean this_present_domain = true && this.isSetDomain();
+ boolean that_present_domain = true && that.isSetDomain();
+ if (this_present_domain || that_present_domain) {
+ if (!(this_present_domain && that_present_domain))
return false;
- if (!this.domainId.equals(that.domainId))
+ if (!this.domain.equals(that.domain))
return false;
}
@@ -6996,10 +6996,10 @@ public class SharingRegistryService {
public int hashCode() {
List<Object> list = new ArrayList<Object>();
- boolean present_domainId = true && (isSetDomainId());
- list.add(present_domainId);
- if (present_domainId)
- list.add(domainId);
+ boolean present_domain = true && (isSetDomain());
+ list.add(present_domain);
+ if (present_domain)
+ list.add(domain);
return list.hashCode();
}
@@ -7012,12 +7012,12 @@ public class SharingRegistryService {
int lastComparison = 0;
- lastComparison = Boolean.valueOf(isSetDomainId()).compareTo(other.isSetDomainId());
+ lastComparison = Boolean.valueOf(isSetDomain()).compareTo(other.isSetDomain());
if (lastComparison != 0) {
return lastComparison;
}
- if (isSetDomainId()) {
- lastComparison = org.apache.thrift.TBaseHelper.compareTo(this.domainId, other.domainId);
+ if (isSetDomain()) {
+ lastComparison = org.apache.thrift.TBaseHelper.compareTo(this.domain, other.domain);
if (lastComparison != 0) {
return lastComparison;
}
@@ -7042,11 +7042,11 @@ public class SharingRegistryService {
StringBuilder sb = new StringBuilder("createDomain_args(");
boolean first = true;
- sb.append("domainId:");
- if (this.domainId == null) {
+ sb.append("domain:");
+ if (this.domain == null) {
sb.append("null");
} else {
- sb.append(this.domainId);
+ sb.append(this.domain);
}
first = false;
sb.append(")");
@@ -7055,12 +7055,12 @@ public class SharingRegistryService {
public void validate() throws org.apache.thrift.TException {
// check for required fields
- if (domainId == null) {
- throw new org.apache.thrift.protocol.TProtocolException("Required field 'domainId' was not present! Struct: " + toString());
+ if (domain == null) {
+ throw new org.apache.thrift.protocol.TProtocolException("Required field 'domain' was not present! Struct: " + toString());
}
// check for sub-struct validity
- if (domainId != null) {
- domainId.validate();
+ if (domain != null) {
+ domain.validate();
}
}
@@ -7098,11 +7098,11 @@ public class SharingRegistryService {
break;
}
switch (schemeField.id) {
- case 1: // DOMAIN_ID
+ case 1: // DOMAIN
if (schemeField.type == org.apache.thrift.protocol.TType.STRUCT) {
- struct.domainId = new org.apache.airavata.sharing.registry.models.Domain();
- struct.domainId.read(iprot);
- struct.setDomainIdIsSet(true);
+ struct.domain = new org.apache.airavata.sharing.registry.models.Domain();
+ struct.domain.read(iprot);
+ struct.setDomainIsSet(true);
} else {
org.apache.thrift.protocol.TProtocolUtil.skip(iprot, schemeField.type);
}
@@ -7122,9 +7122,9 @@ public class SharingRegistryService {
struct.validate();
oprot.writeStructBegin(STRUCT_DESC);
- if (struct.domainId != null) {
- oprot.writeFieldBegin(DOMAIN_ID_FIELD_DESC);
- struct.domainId.write(oprot);
+ if (struct.domain != null) {
+ oprot.writeFieldBegin(DOMAIN_FIELD_DESC);
+ struct.domain.write(oprot);
oprot.writeFieldEnd();
}
oprot.writeFieldStop();
@@ -7144,15 +7144,15 @@ public class SharingRegistryService {
@Override
public void write(org.apache.thrift.protocol.TProtocol prot, createDomain_args struct) throws org.apache.thrift.TException {
TTupleProtocol oprot = (TTupleProtocol) prot;
- struct.domainId.write(oprot);
+ struct.domain.write(oprot);
}
@Override
public void read(org.apache.thrift.protocol.TProtocol prot, createDomain_args struct) throws org.apache.thrift.TException {
TTupleProtocol iprot = (TTupleProtocol) prot;
- struct.domainId = new org.apache.airavata.sharing.registry.models.Domain();
- struct.domainId.read(iprot);
- struct.setDomainIdIsSet(true);
+ struct.domain = new org.apache.airavata.sharing.registry.models.Domain();
+ struct.domain.read(iprot);
+ struct.setDomainIsSet(true);
}
}
@@ -7629,7 +7629,7 @@ public class SharingRegistryService {
public static class updateDomain_args implements org.apache.thrift.TBase<updateDomain_args, updateDomain_args._Fields>, java.io.Serializable, Cloneable, Comparable<updateDomain_args> {
private static final org.apache.thrift.protocol.TStruct STRUCT_DESC = new org.apache.thrift.protocol.TStruct("updateDomain_args");
- private static final org.apache.thrift.protocol.TField DOMAIN_ID_FIELD_DESC = new org.apache.thrift.protocol.TField("domainId", org.apache.thrift.protocol.TType.STRUCT, (short)1);
+ private static final org.apache.thrift.protocol.TField DOMAIN_FIELD_DESC = new org.apache.thrift.protocol.TField("domain", org.apache.thrift.protocol.TType.STRUCT, (short)1);
private static final Map<Class<? extends IScheme>, SchemeFactory> schemes = new HashMap<Class<? extends IScheme>, SchemeFactory>();
static {
@@ -7637,11 +7637,11 @@ public class SharingRegistryService {
schemes.put(TupleScheme.class, new updateDomain_argsTupleSchemeFactory());
}
- public org.apache.airavata.sharing.registry.models.Domain domainId; // required
+ public org.apache.airavata.sharing.registry.models.Domain domain; // required
/** The set of fields this struct contains, along with convenience methods for finding and manipulating them. */
public enum _Fields implements org.apache.thrift.TFieldIdEnum {
- DOMAIN_ID((short)1, "domainId");
+ DOMAIN((short)1, "domain");
private static final Map<String, _Fields> byName = new HashMap<String, _Fields>();
@@ -7656,8 +7656,8 @@ public class SharingRegistryService {
*/
public static _Fields findByThriftId(int fieldId) {
switch(fieldId) {
- case 1: // DOMAIN_ID
- return DOMAIN_ID;
+ case 1: // DOMAIN
+ return DOMAIN;
default:
return null;
}
@@ -7701,7 +7701,7 @@ public class SharingRegistryService {
public static final Map<_Fields, org.apache.thrift.meta_data.FieldMetaData> metaDataMap;
static {
Map<_Fields, org.apache.thrift.meta_data.FieldMetaData> tmpMap = new EnumMap<_Fields, org.apache.thrift.meta_data.FieldMetaData>(_Fields.class);
- tmpMap.put(_Fields.DOMAIN_ID, new org.apache.thrift.meta_data.FieldMetaData("domainId", org.apache.thrift.TFieldRequirementType.REQUIRED,
+ tmpMap.put(_Fields.DOMAIN, new org.apache.thrift.meta_data.FieldMetaData("domain", org.apache.thrift.TFieldRequirementType.REQUIRED,
new org.apache.thrift.meta_data.StructMetaData(org.apache.thrift.protocol.TType.STRUCT, org.apache.airavata.sharing.registry.models.Domain.class)));
metaDataMap = Collections.unmodifiableMap(tmpMap);
org.apache.thrift.meta_data.FieldMetaData.addStructMetaDataMap(updateDomain_args.class, metaDataMap);
@@ -7711,18 +7711,18 @@ public class SharingRegistryService {
}
public updateDomain_args(
- org.apache.airavata.sharing.registry.models.Domain domainId)
+ org.apache.airavata.sharing.registry.models.Domain domain)
{
this();
- this.domainId = domainId;
+ this.domain = domain;
}
/**
* Performs a deep copy on <i>other</i>.
*/
public updateDomain_args(updateDomain_args other) {
- if (other.isSetDomainId()) {
- this.domainId = new org.apache.airavata.sharing.registry.models.Domain(other.domainId);
+ if (other.isSetDomain()) {
+ this.domain = new org.apache.airavata.sharing.registry.models.Domain(other.domain);
}
}
@@ -7732,40 +7732,40 @@ public class SharingRegistryService {
@Override
public void clear() {
- this.domainId = null;
+ this.domain = null;
}
- public org.apache.airavata.sharing.registry.models.Domain getDomainId() {
- return this.domainId;
+ public org.apache.airavata.sharing.registry.models.Domain getDomain() {
+ return this.domain;
}
- public updateDomain_args setDomainId(org.apache.airavata.sharing.registry.models.Domain domainId) {
- this.domainId = domainId;
+ public updateDomain_args setDomain(org.apache.airavata.sharing.registry.models.Domain domain) {
+ this.domain = domain;
return this;
}
- public void unsetDomainId() {
- this.domainId = null;
+ public void unsetDomain() {
+ this.domain = null;
}
- /** Returns true if field domainId is set (has been assigned a value) and false otherwise */
- public boolean isSetDomainId() {
- return this.domainId != null;
+ /** Returns true if field domain is set (has been assigned a value) and false otherwise */
+ public boolean isSetDomain() {
+ return this.domain != null;
}
- public void setDomainIdIsSet(boolean value) {
+ public void setDomainIsSet(boolean value) {
if (!value) {
- this.domainId = null;
+ this.domain = null;
}
}
public void setFieldValue(_Fields field, Object value) {
switch (field) {
- case DOMAIN_ID:
+ case DOMAIN:
if (value == null) {
- unsetDomainId();
+ unsetDomain();
} else {
- setDomainId((org.apache.airavata.sharing.registry.models.Domain)value);
+ setDomain((org.apache.airavata.sharing.registry.models.Domain)value);
}
break;
@@ -7774,8 +7774,8 @@ public class SharingRegistryService {
public Object getFieldValue(_Fields field) {
switch (field) {
- case DOMAIN_ID:
- return getDomainId();
+ case DOMAIN:
+ return getDomain();
}
throw new IllegalStateException();
@@ -7788,8 +7788,8 @@ public class SharingRegistryService {
}
switch (field) {
- case DOMAIN_ID:
- return isSetDomainId();
+ case DOMAIN:
+ return isSetDomain();
}
throw new IllegalStateException();
}
@@ -7807,12 +7807,12 @@ public class SharingRegistryService {
if (that == null)
return false;
- boolean this_present_domainId = true && this.isSetDomainId();
- boolean that_present_domainId = true && that.isSetDomainId();
- if (this_present_domainId || that_present_domainId) {
- if (!(this_present_domainId && that_present_domainId))
+ boolean this_present_domain = true && this.isSetDomain();
+ boolean that_present_domain = true && that.isSetDomain();
+ if (this_present_domain || that_present_domain) {
+ if (!(this_present_domain && that_present_domain))
return false;
- if (!this.domainId.equals(that.domainId))
+ if (!this.domain.equals(that.domain))
return false;
}
@@ -7823,10 +7823,10 @@ public class SharingRegistryService {
public int hashCode() {
List<Object> list = new ArrayList<Object>();
- boolean present_domainId = true && (isSetDomainId());
- list.add(present_domainId);
- if (present_domainId)
- list.add(domainId);
+ boolean present_domain = true && (isSetDomain());
+ list.add(present_domain);
+ if (present_domain)
+ list.add(domain);
return list.hashCode();
}
@@ -7839,12 +7839,12 @@ public class SharingRegistryService {
int lastComparison = 0;
- lastComparison = Boolean.valueOf(isSetDomainId()).compareTo(other.isSetDomainId());
+ lastComparison = Boolean.valueOf(isSetDomain()).compareTo(other.isSetDomain());
if (lastComparison != 0) {
return lastComparison;
}
- if (isSetDomainId()) {
- lastComparison = org.apache.thrift.TBaseHelper.compareTo(this.domainId, other.domainId);
+ if (isSetDomain()) {
+ lastComparison = org.apache.thrift.TBaseHelper.compareTo(this.domain, other.domain);
if (lastComparison != 0) {
return lastComparison;
}
@@ -7869,11 +7869,11 @@ public class SharingRegistryService {
StringBuilder sb = new StringBuilder("updateDomain_args(");
boolean first = true;
- sb.append("domainId:");
- if (this.domainId == null) {
+ sb.append("domain:");
+ if (this.domain == null) {
sb.append("null");
} else {
- sb.append(this.domainId);
+ sb.append(this.domain);
}
first = false;
sb.append(")");
@@ -7882,12 +7882,12 @@ public class SharingRegistryService {
public void validate() throws org.apache.thrift.TException {
// check for required fields
- if (domainId == null) {
- throw new org.apache.thrift.protocol.TProtocolException("Required field 'domainId' was not present! Struct: " + toString());
+ if (domain == null) {
+ throw new org.apache.thrift.protocol.TProtocolException("Required field 'domain' was not present! Struct: " + toString());
}
// check for sub-struct validity
- if (domainId != null) {
- domainId.validate();
+ if (domain != null) {
+ domain.validate();
}
}
@@ -7925,11 +7925,11 @@ public class SharingRegistryService {
break;
}
switch (schemeField.id) {
- case 1: // DOMAIN_ID
+ case 1: // DOMAIN
if (schemeField.type == org.apache.thrift.protocol.TType.STRUCT) {
- struct.domainId = new org.apache.airavata.sharing.registry.models.Domain();
- struct.domainId.read(iprot);
- struct.setDomainIdIsSet(true);
+ struct.domain = new org.apache.airavata.sharing.registry.models.Domain();
+ struct.domain.read(iprot);
+ struct.setDomainIsSet(true);
} else {
org.apache.thrift.protocol.TProtocolUtil.skip(iprot, schemeField.type);
}
@@ -7949,9 +7949,9 @@ public class SharingRegistryService {
struct.validate();
oprot.writeStructBegin(STRUCT_DESC);
- if (struct.domainId != null) {
- oprot.writeFieldBegin(DOMAIN_ID_FIELD_DESC);
- struct.domainId.write(oprot);
+ if (struct.domain != null) {
+ oprot.writeFieldBegin(DOMAIN_FIELD_DESC);
+ struct.domain.write(oprot);
oprot.writeFieldEnd();
}
oprot.writeFieldStop();
@@ -7971,15 +7971,15 @@ public class SharingRegistryService {
@Override
public void write(org.apache.thrift.protocol.TProtocol prot, updateDomain_args struct) throws org.apache.thrift.TException {
TTupleProtocol oprot = (TTupleProtocol) prot;
- struct.domainId.write(oprot);
+ struct.domain.write(oprot);
}
@Override
public void read(org.apache.thrift.protocol.TProtocol prot, updateDomain_args struct) throws org.apache.thrift.TException {
TTupleProtocol iprot = (TTupleProtocol) prot;
- struct.domainId = new org.apache.airavata.sharing.registry.models.Domain();
- struct.domainId.read(iprot);
- struct.setDomainIdIsSet(true);
+ struct.domain = new org.apache.airavata.sharing.registry.models.Domain();
+ struct.domain.read(iprot);
+ struct.setDomainIsSet(true);
}
}
http://git-wip-us.apache.org/repos/asf/airavata/blob/61a0fc95/modules/sharing-registry/sharing-service-docs/api-docs/index.html
----------------------------------------------------------------------
diff --git a/modules/sharing-registry/sharing-service-docs/api-docs/index.html b/modules/sharing-registry/sharing-service-docs/api-docs/index.html
new file mode 100644
index 0000000..6663a9d
--- /dev/null
+++ b/modules/sharing-registry/sharing-service-docs/api-docs/index.html
@@ -0,0 +1,79 @@
+<html><head>
+<link href="style.css" rel="stylesheet" type="text/css"/>
+<title>All Thrift declarations</title></head><body>
+<div class="container-fluid">
+<h1>All Thrift declarations</h1>
+<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead>
+<tr>
+<td>sharing_cpi</td><td><a href="sharing_cpi.html#Svc_SharingRegistryService">SharingRegistryService</a><br/>
+<ul>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_addChildGroupsToParentGroup">addChildGroupsToParentGroup</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_addUsersToGroup">addUsersToGroup</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_createDomain">createDomain</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_createEntityType">createEntityType</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_createGroup">createGroup</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_createPermissionType">createPermissionType</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_deleteDomain">deleteDomain</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_deleteEntity">deleteEntity</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_deleteEntityType">deleteEntityType</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_deleteGroup">deleteGroup</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_deletePermissionType">deletePermissionType</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_deleteUser">deleteUser</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getDomain">getDomain</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getDomains">getDomains</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getEntity">getEntity</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getEntityType">getEntityType</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getEntityTypes">getEntityTypes</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getGroup">getGroup</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getGroupMembersOfTypeGroup">getGroupMembersOfTypeGroup</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getGroupMembersOfTypeUser">getGroupMembersOfTypeUser</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getGroups">getGroups</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getListOfSharedGroups">getListOfSharedGroups</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getListOfSharedUsers">getListOfSharedUsers</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getPermissionType">getPermissionType</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getPermissionTypes">getPermissionTypes</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getUser">getUser</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_getUsers">getUsers</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_registerEntity">registerEntity</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_registerUser">registerUser</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_removeChildGroupFromParentGroup">removeChildGroupFromParentGroup</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_removeUsersFromGroup">removeUsersFromGroup</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_revokeEntitySharingFromGroups">revokeEntitySharingFromGroups</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_revokeEntitySharingFromUsers">revokeEntitySharingFromUsers</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_searchEntities">searchEntities</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_shareEntityWithGroups">shareEntityWithGroups</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_shareEntityWithUsers">shareEntityWithUsers</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_updateDomain">updateDomain</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_updateEntity">updateEntity</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_updateEntityType">updateEntityType</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_updateGroup">updateGroup</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_updatePermissionType">updatePermissionType</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_updatedUser">updatedUser</a></li>
+<li><a href="sharing_cpi.html#Fn_SharingRegistryService_userHasAccess">userHasAccess</a></li>
+</ul>
+</td>
+<td></td>
+<td></code></td>
+</tr><tr>
+<td>sharing_models</td><td></td>
+<td><a href="sharing_models.html#Struct_Domain">Domain</a><br/>
+<a href="sharing_models.html#Struct_Entity">Entity</a><br/>
+<a href="sharing_models.html#Enum_EntitySearchField">EntitySearchField</a><br/>
+<a href="sharing_models.html#Struct_EntityType">EntityType</a><br/>
+<a href="sharing_models.html#Enum_GroupCardinality">GroupCardinality</a><br/>
+<a href="sharing_models.html#Enum_GroupChildType">GroupChildType</a><br/>
+<a href="sharing_models.html#Struct_GroupMembership">GroupMembership</a><br/>
+<a href="sharing_models.html#Enum_GroupType">GroupType</a><br/>
+<a href="sharing_models.html#Struct_PermissionType">PermissionType</a><br/>
+<a href="sharing_models.html#Enum_SearchCondition">SearchCondition</a><br/>
+<a href="sharing_models.html#Struct_SearchCriteria">SearchCriteria</a><br/>
+<a href="sharing_models.html#Struct_Sharing">Sharing</a><br/>
+<a href="sharing_models.html#Struct_SharingRegistryException">SharingRegistryException</a><br/>
+<a href="sharing_models.html#Enum_SharingType">SharingType</a><br/>
+<a href="sharing_models.html#Struct_User">User</a><br/>
+<a href="sharing_models.html#Struct_UserGroup">UserGroup</a><br/>
+</td>
+<td><code><a href="sharing_models.html#Const_DO_NOT_SET_AT_CLIENTS_ID">DO_NOT_SET_AT_CLIENTS_ID</a></code><br/>
+</code></td>
+</tr></table>
+</div></body></html>
http://git-wip-us.apache.org/repos/asf/airavata/blob/61a0fc95/modules/sharing-registry/sharing-service-docs/api-docs/sharing_cpi.html
----------------------------------------------------------------------
diff --git a/modules/sharing-registry/sharing-service-docs/api-docs/sharing_cpi.html b/modules/sharing-registry/sharing-service-docs/api-docs/sharing_cpi.html
new file mode 100644
index 0000000..9b6253d
--- /dev/null
+++ b/modules/sharing-registry/sharing-service-docs/api-docs/sharing_cpi.html
@@ -0,0 +1,278 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+<link href="style.css" rel="stylesheet" type="text/css"/>
+<title>Thrift module: sharing_cpi</title></head><body>
+<div class="container-fluid">
+<h1>Thrift module: sharing_cpi</h1>
+<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead>
+<tr>
+<td>sharing_cpi</td><td><a href="#Svc_SharingRegistryService">SharingRegistryService</a><br/>
+<ul>
+<li><a href="#Fn_SharingRegistryService_addChildGroupsToParentGroup">addChildGroupsToParentGroup</a></li>
+<li><a href="#Fn_SharingRegistryService_addUsersToGroup">addUsersToGroup</a></li>
+<li><a href="#Fn_SharingRegistryService_createDomain">createDomain</a></li>
+<li><a href="#Fn_SharingRegistryService_createEntityType">createEntityType</a></li>
+<li><a href="#Fn_SharingRegistryService_createGroup">createGroup</a></li>
+<li><a href="#Fn_SharingRegistryService_createPermissionType">createPermissionType</a></li>
+<li><a href="#Fn_SharingRegistryService_deleteDomain">deleteDomain</a></li>
+<li><a href="#Fn_SharingRegistryService_deleteEntity">deleteEntity</a></li>
+<li><a href="#Fn_SharingRegistryService_deleteEntityType">deleteEntityType</a></li>
+<li><a href="#Fn_SharingRegistryService_deleteGroup">deleteGroup</a></li>
+<li><a href="#Fn_SharingRegistryService_deletePermissionType">deletePermissionType</a></li>
+<li><a href="#Fn_SharingRegistryService_deleteUser">deleteUser</a></li>
+<li><a href="#Fn_SharingRegistryService_getDomain">getDomain</a></li>
+<li><a href="#Fn_SharingRegistryService_getDomains">getDomains</a></li>
+<li><a href="#Fn_SharingRegistryService_getEntity">getEntity</a></li>
+<li><a href="#Fn_SharingRegistryService_getEntityType">getEntityType</a></li>
+<li><a href="#Fn_SharingRegistryService_getEntityTypes">getEntityTypes</a></li>
+<li><a href="#Fn_SharingRegistryService_getGroup">getGroup</a></li>
+<li><a href="#Fn_SharingRegistryService_getGroupMembersOfTypeGroup">getGroupMembersOfTypeGroup</a></li>
+<li><a href="#Fn_SharingRegistryService_getGroupMembersOfTypeUser">getGroupMembersOfTypeUser</a></li>
+<li><a href="#Fn_SharingRegistryService_getGroups">getGroups</a></li>
+<li><a href="#Fn_SharingRegistryService_getListOfSharedGroups">getListOfSharedGroups</a></li>
+<li><a href="#Fn_SharingRegistryService_getListOfSharedUsers">getListOfSharedUsers</a></li>
+<li><a href="#Fn_SharingRegistryService_getPermissionType">getPermissionType</a></li>
+<li><a href="#Fn_SharingRegistryService_getPermissionTypes">getPermissionTypes</a></li>
+<li><a href="#Fn_SharingRegistryService_getUser">getUser</a></li>
+<li><a href="#Fn_SharingRegistryService_getUsers">getUsers</a></li>
+<li><a href="#Fn_SharingRegistryService_registerEntity">registerEntity</a></li>
+<li><a href="#Fn_SharingRegistryService_registerUser">registerUser</a></li>
+<li><a href="#Fn_SharingRegistryService_removeChildGroupFromParentGroup">removeChildGroupFromParentGroup</a></li>
+<li><a href="#Fn_SharingRegistryService_removeUsersFromGroup">removeUsersFromGroup</a></li>
+<li><a href="#Fn_SharingRegistryService_revokeEntitySharingFromGroups">revokeEntitySharingFromGroups</a></li>
+<li><a href="#Fn_SharingRegistryService_revokeEntitySharingFromUsers">revokeEntitySharingFromUsers</a></li>
+<li><a href="#Fn_SharingRegistryService_searchEntities">searchEntities</a></li>
+<li><a href="#Fn_SharingRegistryService_shareEntityWithGroups">shareEntityWithGroups</a></li>
+<li><a href="#Fn_SharingRegistryService_shareEntityWithUsers">shareEntityWithUsers</a></li>
+<li><a href="#Fn_SharingRegistryService_updateDomain">updateDomain</a></li>
+<li><a href="#Fn_SharingRegistryService_updateEntity">updateEntity</a></li>
+<li><a href="#Fn_SharingRegistryService_updateEntityType">updateEntityType</a></li>
+<li><a href="#Fn_SharingRegistryService_updateGroup">updateGroup</a></li>
+<li><a href="#Fn_SharingRegistryService_updatePermissionType">updatePermissionType</a></li>
+<li><a href="#Fn_SharingRegistryService_updatedUser">updatedUser</a></li>
+<li><a href="#Fn_SharingRegistryService_userHasAccess">userHasAccess</a></li>
+</ul>
+</td>
+<td></td>
+<td></code></td>
+</tr></table>
+<hr/><h2 id="Services">Services</h2>
+<h3 id="Svc_SharingRegistryService">Service: SharingRegistryService</h3>
+<div class="definition"><h4 id="Fn_SharingRegistryService_createDomain">Function: SharingRegistryService.createDomain</h4>
+<pre><code>string</code> createDomain(<code><a href="sharing_models.html#Struct_Domain">sharing_models.Domain</a></code> domain)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to create a new domain</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_updateDomain">Function: SharingRegistryService.updateDomain</h4>
+<pre><code>bool</code> updateDomain(<code><a href="sharing_models.html#Struct_Domain">sharing_models.Domain</a></code> domain)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to update a domain</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_deleteDomain">Function: SharingRegistryService.deleteDomain</h4>
+<pre><code>bool</code> deleteDomain(<code>string</code> domainId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to delete domain</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getDomain">Function: SharingRegistryService.getDomain</h4>
+<pre><code><a href="sharing_models.html#Struct_Domain">sharing_models.Domain</a></code> getDomain(<code>string</code> domainId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to retrieve a domain</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getDomains">Function: SharingRegistryService.getDomains</h4>
+<pre><code>list<<code><a href="sharing_models.html#Struct_Domain">sharing_models.Domain</a></code>></code> getDomains(<code>i32</code> offset,
+ <code>i32</code> limit)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to get all domain.</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_registerUser">Function: SharingRegistryService.registerUser</h4>
+<pre><code>string</code> registerUser(<code><a href="sharing_models.html#Struct_User">sharing_models.User</a></code> user)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to register a user in the system</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_updatedUser">Function: SharingRegistryService.updatedUser</h4>
+<pre><code>bool</code> updatedUser(<code><a href="sharing_models.html#Struct_User">sharing_models.User</a></code> user)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to update existing user</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_deleteUser">Function: SharingRegistryService.deleteUser</h4>
+<pre><code>bool</code> deleteUser(<code>string</code> userId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to delete user</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getUser">Function: SharingRegistryService.getUser</h4>
+<pre><code><a href="sharing_models.html#Struct_User">sharing_models.User</a></code> getUser(<code>string</code> userId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to get a user</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getUsers">Function: SharingRegistryService.getUsers</h4>
+<pre><code>list<<code><a href="sharing_models.html#Struct_User">sharing_models.User</a></code>></code> getUsers(<code>string</code> domainId,
+ <code>i32</code> offset,
+ <code>i32</code> limit)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to get a list of users in a specific domain Users will be reverse sorted based on the created time.</p>
+<li>domainId : Domain id</li>
+<li>offset : Starting result number</li>
+<li>limit : Number of max results to be sent</li>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_createGroup">Function: SharingRegistryService.createGroup</h4>
+<pre><code>string</code> createGroup(<code><a href="sharing_models.html#Struct_UserGroup">sharing_models.UserGroup</a></code> group)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to create a new group</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_updateGroup">Function: SharingRegistryService.updateGroup</h4>
+<pre><code>bool</code> updateGroup(<code><a href="sharing_models.html#Struct_UserGroup">sharing_models.UserGroup</a></code> group)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to update a group</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_deleteGroup">Function: SharingRegistryService.deleteGroup</h4>
+<pre><code>bool</code> deleteGroup(<code>string</code> groupId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to delete a group</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getGroup">Function: SharingRegistryService.getGroup</h4>
+<pre><code><a href="sharing_models.html#Struct_UserGroup">sharing_models.UserGroup</a></code> getGroup(<code>string</code> groupId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to get a group</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getGroups">Function: SharingRegistryService.getGroups</h4>
+<pre><code>list<<code><a href="sharing_models.html#Struct_UserGroup">sharing_models.UserGroup</a></code>></code> getGroups(<code>string</code> domainId,
+ <code>i32</code> offset,
+ <code>i32</code> limit)
+</pre><p>API method to get groups in a domainId. Results are reverse sorted based on created time.</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_addUsersToGroup">Function: SharingRegistryService.addUsersToGroup</h4>
+<pre><code>bool</code> addUsersToGroup(<code>list<<code>string</code>></code> userIds,
+ <code>string</code> groupId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to add list of users to a group</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_removeUsersFromGroup">Function: SharingRegistryService.removeUsersFromGroup</h4>
+<pre><code>bool</code> removeUsersFromGroup(<code>list<<code>string</code>></code> userIds,
+ <code>string</code> groupId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to remove users from a group</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getGroupMembersOfTypeUser">Function: SharingRegistryService.getGroupMembersOfTypeUser</h4>
+<pre><code>list<<code><a href="sharing_models.html#Struct_User">sharing_models.User</a></code>></code> getGroupMembersOfTypeUser(<code>string</code> groupId,
+ <code>i32</code> offset,
+ <code>i32</code> limit)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to get list of child users in a group. Only the direct members will be returned. Results are reverse time sorted based on creation time</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getGroupMembersOfTypeGroup">Function: SharingRegistryService.getGroupMembersOfTypeGroup</h4>
+<pre><code>list<<code><a href="sharing_models.html#Struct_UserGroup">sharing_models.UserGroup</a></code>></code> getGroupMembersOfTypeGroup(<code>string</code> groupId,
+ <code>i32</code> offset,
+ <code>i32</code> limit)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to get list of child groups in a group. Only the direct members will be returned. Results are reverse time sorted based on creation time</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_addChildGroupsToParentGroup">Function: SharingRegistryService.addChildGroupsToParentGroup</h4>
+<pre><code>bool</code> addChildGroupsToParentGroup(<code>list<<code>string</code>></code> childIds,
+ <code>string</code> groupId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to add a child group to a parent group.</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_removeChildGroupFromParentGroup">Function: SharingRegistryService.removeChildGroupFromParentGroup</h4>
+<pre><code>bool</code> removeChildGroupFromParentGroup(<code>string</code> childId,
+ <code>string</code> groupId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to remove a child group from parent group.</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_createEntityType">Function: SharingRegistryService.createEntityType</h4>
+<pre><code>string</code> createEntityType(<code><a href="sharing_models.html#Struct_EntityType">sharing_models.EntityType</a></code> entityType)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to create a new entity type</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_updateEntityType">Function: SharingRegistryService.updateEntityType</h4>
+<pre><code>bool</code> updateEntityType(<code><a href="sharing_models.html#Struct_EntityType">sharing_models.EntityType</a></code> entityType)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to update entity type</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_deleteEntityType">Function: SharingRegistryService.deleteEntityType</h4>
+<pre><code>bool</code> deleteEntityType(<code>string</code> entityTypeId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to delete entity type</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getEntityType">Function: SharingRegistryService.getEntityType</h4>
+<pre><code><a href="sharing_models.html#Struct_EntityType">sharing_models.EntityType</a></code> getEntityType(<code>string</code> entityTypeId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to get an entity type</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getEntityTypes">Function: SharingRegistryService.getEntityTypes</h4>
+<pre><code>list<<code><a href="sharing_models.html#Struct_EntityType">sharing_models.EntityType</a></code>></code> getEntityTypes(<code>string</code> domainId,
+ <code>i32</code> offset,
+ <code>i32</code> limit)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to get entity types in a domainId. Results are reverse time sorted based on creation time</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_registerEntity">Function: SharingRegistryService.registerEntity</h4>
+<pre><code>string</code> registerEntity(<code><a href="sharing_models.html#Struct_Entity">sharing_models.Entity</a></code> entity)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to register new entity</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_updateEntity">Function: SharingRegistryService.updateEntity</h4>
+<pre><code>bool</code> updateEntity(<code><a href="sharing_models.html#Struct_Entity">sharing_models.Entity</a></code> entity)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to update entity</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_deleteEntity">Function: SharingRegistryService.deleteEntity</h4>
+<pre><code>bool</code> deleteEntity(<code>string</code> entityId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to delete entity</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getEntity">Function: SharingRegistryService.getEntity</h4>
+<pre><code><a href="sharing_models.html#Struct_Entity">sharing_models.Entity</a></code> getEntity(<code>string</code> entityId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to get entity</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_searchEntities">Function: SharingRegistryService.searchEntities</h4>
+<pre><code>list<<code><a href="sharing_models.html#Struct_Entity">sharing_models.Entity</a></code>></code> searchEntities(<code>string</code> userId,
+ <code>string</code> entityTypeId,
+ <code>list<<code><a href="sharing_models.html#Struct_SearchCriteria">sharing_models.SearchCriteria</a></code>></code> filters,
+ <code>i32</code> offset,
+ <code>i32</code> limit)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to search entities</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getListOfSharedUsers">Function: SharingRegistryService.getListOfSharedUsers</h4>
+<pre><code>list<<code><a href="sharing_models.html#Struct_User">sharing_models.User</a></code>></code> getListOfSharedUsers(<code>string</code> entityId,
+ <code>string</code> permissionTypeId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to get a list of shared users given the entity id</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getListOfSharedGroups">Function: SharingRegistryService.getListOfSharedGroups</h4>
+<pre><code>list<<code><a href="sharing_models.html#Struct_UserGroup">sharing_models.UserGroup</a></code>></code> getListOfSharedGroups(<code>string</code> entityId,
+ <code>string</code> permissionTypeId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to get a list of shared groups given the entity id</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_createPermissionType">Function: SharingRegistryService.createPermissionType</h4>
+<pre><code>string</code> createPermissionType(<code><a href="sharing_models.html#Struct_PermissionType">sharing_models.PermissionType</a></code> permissionType)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to create permission type</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_updatePermissionType">Function: SharingRegistryService.updatePermissionType</h4>
+<pre><code>bool</code> updatePermissionType(<code><a href="sharing_models.html#Struct_PermissionType">sharing_models.PermissionType</a></code> permissionType)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to update permission type</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_deletePermissionType">Function: SharingRegistryService.deletePermissionType</h4>
+<pre><code>bool</code> deletePermissionType(<code>string</code> entityTypeId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to delete permission type</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getPermissionType">Function: SharingRegistryService.getPermissionType</h4>
+<pre><code><a href="sharing_models.html#Struct_PermissionType">sharing_models.PermissionType</a></code> getPermissionType(<code>string</code> permissionTypeId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to get permission type</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_getPermissionTypes">Function: SharingRegistryService.getPermissionTypes</h4>
+<pre><code>list<<code><a href="sharing_models.html#Struct_PermissionType">sharing_models.PermissionType</a></code>></code> getPermissionTypes(<code>string</code> domainId,
+ <code>i32</code> offset,
+ <code>i32</code> limit)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to get list of permission types in a given domainId. Results are reverse time sorted based on creation time</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_shareEntityWithUsers">Function: SharingRegistryService.shareEntityWithUsers</h4>
+<pre><code>bool</code> shareEntityWithUsers(<code>string</code> domainId,
+ <code>string</code> entityId,
+ <code>list<<code>string</code>></code> userList,
+ <code>string</code> perssionTypeId,
+ <code>bool</code> cascadePermission)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to share an entity with users</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_revokeEntitySharingFromUsers">Function: SharingRegistryService.revokeEntitySharingFromUsers</h4>
+<pre><code>bool</code> revokeEntitySharingFromUsers(<code>string</code> domainId,
+ <code>string</code> entityId,
+ <code>list<<code>string</code>></code> userList,
+ <code>string</code> perssionTypeId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to revoke sharing from a list of users</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_shareEntityWithGroups">Function: SharingRegistryService.shareEntityWithGroups</h4>
+<pre><code>bool</code> shareEntityWithGroups(<code>string</code> domainId,
+ <code>string</code> entityId,
+ <code>list<<code>string</code>></code> groupList,
+ <code>string</code> perssionTypeId,
+ <code>bool</code> cascadePermission)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to share an entity with list of groups</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_revokeEntitySharingFromGroups">Function: SharingRegistryService.revokeEntitySharingFromGroups</h4>
+<pre><code>bool</code> revokeEntitySharingFromGroups(<code>string</code> domainId,
+ <code>string</code> entityId,
+ <code>list<<code>string</code>></code> groupList,
+ <code>string</code> perssionTypeId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to revoke sharing from list of users</p>
+<br/></div><div class="definition"><h4 id="Fn_SharingRegistryService_userHasAccess">Function: SharingRegistryService.userHasAccess</h4>
+<pre><code>bool</code> userHasAccess(<code>string</code> domainId,
+ <code>string</code> userId,
+ <code>string</code> entityId,
+ <code>string</code> permissionTypeId)
+ throws <code><a href="sharing_models.html#Struct_SharingRegistryException">sharing_models.SharingRegistryException</a></code>
+</pre><p>API method to check whether a user has access to a specific entity</p>
+<br/></div></div></body></html>
http://git-wip-us.apache.org/repos/asf/airavata/blob/61a0fc95/modules/sharing-registry/sharing-service-docs/api-docs/sharing_models.html
----------------------------------------------------------------------
diff --git a/modules/sharing-registry/sharing-service-docs/api-docs/sharing_models.html b/modules/sharing-registry/sharing-service-docs/api-docs/sharing_models.html
new file mode 100644
index 0000000..1d4dff8
--- /dev/null
+++ b/modules/sharing-registry/sharing-service-docs/api-docs/sharing_models.html
@@ -0,0 +1,273 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+<link href="style.css" rel="stylesheet" type="text/css"/>
+<title>Thrift module: sharing_models</title></head><body>
+<div class="container-fluid">
+<h1>Thrift module: sharing_models</h1>
+<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead>
+<tr>
+<td>sharing_models</td><td></td>
+<td><a href="#Struct_Domain">Domain</a><br/>
+<a href="#Struct_Entity">Entity</a><br/>
+<a href="#Enum_EntitySearchField">EntitySearchField</a><br/>
+<a href="#Struct_EntityType">EntityType</a><br/>
+<a href="#Enum_GroupCardinality">GroupCardinality</a><br/>
+<a href="#Enum_GroupChildType">GroupChildType</a><br/>
+<a href="#Struct_GroupMembership">GroupMembership</a><br/>
+<a href="#Enum_GroupType">GroupType</a><br/>
+<a href="#Struct_PermissionType">PermissionType</a><br/>
+<a href="#Enum_SearchCondition">SearchCondition</a><br/>
+<a href="#Struct_SearchCriteria">SearchCriteria</a><br/>
+<a href="#Struct_Sharing">Sharing</a><br/>
+<a href="#Struct_SharingRegistryException">SharingRegistryException</a><br/>
+<a href="#Enum_SharingType">SharingType</a><br/>
+<a href="#Struct_User">User</a><br/>
+<a href="#Struct_UserGroup">UserGroup</a><br/>
+</td>
+<td><code><a href="#Const_DO_NOT_SET_AT_CLIENTS_ID">DO_NOT_SET_AT_CLIENTS_ID</a></code><br/>
+</code></td>
+</tr></table>
+<hr/><h2 id="Constants">Constants</h2>
+<table class="table-bordered table-striped table-condensed"><thead><th>Constant</th><th>Type</th><th>Value</th></thead>
+<tr id="Const_DO_NOT_SET_AT_CLIENTS_ID"><td><code>DO_NOT_SET_AT_CLIENTS_ID</code></td><td><code>string</code></td><td><code>"DO_NOT_SET_AT_CLIENTS_ID"</code></td></tr></table><hr/><h2 id="Enumerations">Enumerations</h2>
+<div class="definition"><h3 id="Enum_GroupCardinality">Enumeration: GroupCardinality</h3>
+<p>This is an system internal enum used to define single user groups and multi users groups. Every user is also
+considered as a group in it's own right for implementation ease</p>
+
+<br/><br/><table class="table-bordered table-striped table-condensed">
+<tr><td><code>SINGLE_USER</code></td><td><code>0</code></td><td>
+</td></tr>
+<tr><td><code>MULTI_USER</code></td><td><code>1</code></td><td>
+</td></tr>
+</table></div>
+<div class="definition"><h3 id="Enum_GroupType">Enumeration: GroupType</h3>
+<p>Group types can be either user level or domain level groups.</p>
+
+<br/><br/><table class="table-bordered table-striped table-condensed">
+<tr><td><code>DOMAIN_LEVEL_GROUP</code></td><td><code>0</code></td><td>
+</td></tr>
+<tr><td><code>USER_LEVEL_GROUP</code></td><td><code>1</code></td><td>
+</td></tr>
+</table></div>
+<div class="definition"><h3 id="Enum_GroupChildType">Enumeration: GroupChildType</h3>
+<p>System internal data type to match group child types</p>
+
+<br/><br/><table class="table-bordered table-striped table-condensed">
+<tr><td><code>USER</code></td><td><code>0</code></td><td>
+</td></tr>
+<tr><td><code>GROUP</code></td><td><code>1</code></td><td>
+</td></tr>
+</table></div>
+<div class="definition"><h3 id="Enum_EntitySearchField">Enumeration: EntitySearchField</h3>
+<p>This list of fields that can be used to search entities</p>
+<li>NAME : Name of the entity</li>
+<li>DESCRIPTION : Description of the entity</li>
+<li>FULL_TEXT : Full text field of the entity</li>
+<li>PARENT_ENTITY_ID : Parent entity id of the entity</li>
+<li>CREATED_TIME : Created time of the entity</li>
+<li>UPDATED_TIME : Updated time of the entity</li>
+
+<br/><br/><table class="table-bordered table-striped table-condensed">
+<tr><td><code>NAME</code></td><td><code>0</code></td><td>
+</td></tr>
+<tr><td><code>DESCRIPTION</code></td><td><code>1</code></td><td>
+</td></tr>
+<tr><td><code>FULL_TEXT</code></td><td><code>2</code></td><td>
+</td></tr>
+<tr><td><code>PRRENT_ENTITY_ID</code></td><td><code>3</code></td><td>
+</td></tr>
+<tr><td><code>CREATED_TIME</code></td><td><code>4</code></td><td>
+</td></tr>
+<tr><td><code>UPDATED_TIME</code></td><td><code>5</code></td><td>
+</td></tr>
+</table></div>
+<div class="definition"><h3 id="Enum_SearchCondition">Enumeration: SearchCondition</h3>
+<p>Different search operators that can be used with the entity search fields</p>
+<li>EQUAL : Simply matches for equality. Applicable for name, and parent entity id</li>
+<li>LIKE : Check for the condition %$FIELD% condition. Applicable for name, and description</li>
+<li>FULL_TEXT : Does a full text search. Only applicable for the FULL_TEXT field.</li>
+<li>GTE : Greater than or equal. Only applicable for created time and updated time.</li>
+<li>LTE : Less than or equal. Only applicable for created time and updated time.</li>
+
+<br/><br/><table class="table-bordered table-striped table-condensed">
+<tr><td><code>EQUAL</code></td><td><code>0</code></td><td>
+</td></tr>
+<tr><td><code>LIKE</code></td><td><code>1</code></td><td>
+</td></tr>
+<tr><td><code>FULL_TEXT</code></td><td><code>2</code></td><td>
+</td></tr>
+<tr><td><code>GTE</code></td><td><code>3</code></td><td>
+</td></tr>
+<tr><td><code>LTE</code></td><td><code>4</code></td><td>
+</td></tr>
+</table></div>
+<div class="definition"><h3 id="Enum_SharingType">Enumeration: SharingType</h3>
+<p>This is an internal enum type for managing sharings</p>
+
+<br/><br/><table class="table-bordered table-striped table-condensed">
+<tr><td><code>DIRECT_NON_CASCADING</code></td><td><code>0</code></td><td>
+</td></tr>
+<tr><td><code>DIRECT_CASCADING</code></td><td><code>1</code></td><td>
+</td></tr>
+<tr><td><code>INDIRECT_CASCADING</code></td><td><code>2</code></td><td>
+</td></tr>
+</table></div>
+<hr/><h2 id="Structs">Data structures</h2>
+<div class="definition"><h3 id="Struct_Domain">Struct: Domain</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>domainId</td><td><code>string</code></td><td></td><td>optional</td><td><code>"DO_NOT_SET_AT_CLIENTS_ID"</code></td></tr>
+<tr><td>2</td><td>name</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>3</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>4</td><td>createdTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>5</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+</table><br/><p>Domain is the entity that enables multi-tenency in this componenet. Every tenant will be
+operating separately it's own silo which is identified by the domain id. In the current implementation domain id
+will be same as the domain name</p>
+<li>domainId : Will be generated by the server based on the domain name</li>
+<li><b>name</b> : A single word name that identifies the domain e.g seagrid, ultrascan</li>
+<li>description : A short description for the domain</li>
+<li>createdTime : Will be set by the system</li>
+<li>updatedTime : Will be set by the system</li>
+
+<br/></div><div class="definition"><h3 id="Struct_User">Struct: User</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>userId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>2</td><td>domainId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>3</td><td>userName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>4</td><td>firstName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>5</td><td>lastName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>6</td><td>email</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>7</td><td>icon</td><td><code>binary</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>8</td><td>createdTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>9</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+</table><br/><p>User is the model used to register a user in the system. Minimal user information will be required to provide
+regarding the user.</p>
+<li><b>userId</b> : Client provided user id. (The id is not system generated and it is a must to provide this id)</li>
+<li><b>domainId</b> : Domain id for that user</li>
+<li><b>userName</b> : User name for the user</li>
+<li><b>firstName</b> : First name of the user</li>
+<li><b>lastName</b> : Last name of the user</li>
+<li><b>email</b> : Email address of the user</li>
+<li>icon : A binary field for storing the user icon</li>
+<li>createdTime : If client provides this value then the system will use it if not the current time will be set</li>
+<li>updatedTime : If client provides this value then the system will use it if not the current time will be set</li>
+
+<br/></div><div class="definition"><h3 id="Struct_UserGroup">Struct: UserGroup</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>groupId</td><td><code>string</code></td><td></td><td>optional</td><td><code>"DO_NOT_SET_AT_CLIENTS_ID"</code></td></tr>
+<tr><td>2</td><td>domainId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>3</td><td>name</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>4</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>5</td><td>ownerId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>6</td><td>groupType</td><td><code><a href="#Enum_GroupType">GroupType</a></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>7</td><td>groupCardinality</td><td><code><a href="#Enum_GroupCardinality">GroupCardinality</a></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>8</td><td>createdTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>9</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+</table><br/><p>User group is a collection of users.</p>
+ <li>groupId : System generated grouo id. In the current implementation this is of the form domainId:name</li>
+ <li><b>domainId</b> : Domain id for this user group</li>
+ <li><b>name</b> : Name for the user group. should be one word</li>
+ <li>description : Short description for the group.</li>
+ <li><b>ownerId</b> : Owner id of this group.</li>
+ <li><b>groupType</b> : Group type (DOMAIN_LEVEL_GROUP, USER_LEVEL_GROUP)</li>
+ <li><b>groupCardinality</b> : Group cardinality (SINGLE_USER, MULTI_USER)</li>
+ <li>createdTime : Will be set by the system</li>
+ <li>updatedTime : Will be set by the system</li>
+
+<br/></div><div class="definition"><h3 id="Struct_GroupMembership">Struct: GroupMembership</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>parentId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>2</td><td>childId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>3</td><td>childType</td><td><code><a href="#Enum_GroupChildType">GroupChildType</a></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>4</td><td>createdTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>5</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+</table><br/><p>System internal data type to map group memberships</p>
+
+<br/></div><div class="definition"><h3 id="Struct_EntityType">Struct: EntityType</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>entityTypeId</td><td><code>string</code></td><td></td><td>optional</td><td><code>"DO_NOT_SET_AT_CLIENTS_ID"</code></td></tr>
+<tr><td>2</td><td>domainId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>3</td><td>name</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>4</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>5</td><td>createdTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>6</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+</table><br/><p>client defined entity types</p>
+<li>entityTypeId : System generated entity type id. In the current implementation it will of the form domainId:name</li>
+<li><b>domainId</b> : Domain id of the domain.</li>
+<li><b>name</b> : Name for the entity type. Should be a single word.</li>
+<li>description : Short description for the entity type.</li>
+<li>createdTime : Will be set by the system</li>
+<li>updatedTime : Will be set by the system</li>
+
+<br/></div><div class="definition"><h3 id="Struct_SearchCriteria">Struct: SearchCriteria</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>searchField</td><td><code><a href="#Enum_EntitySearchField">EntitySearchField</a></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>2</td><td>value</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>3</td><td>searchCondition</td><td><code><a href="#Enum_SearchCondition">SearchCondition</a></code></td><td></td><td>optional</td><td></td></tr>
+</table><br/><p>Container object for search criteria</p>
+<li><b>searchField</b> : Entity search field</li>
+<li><b>value</b> : Search value</li>
+<li><b>searchCondition</b> : EQUAL, LIKE etc..</li>
+
+<br/></div><div class="definition"><h3 id="Struct_Entity">Struct: Entity</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>entityId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>2</td><td>domainId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>3</td><td>entityTypeId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>4</td><td>ownerId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>5</td><td>parentEntityId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>6</td><td>name</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>7</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>8</td><td>metadata</td><td><code>map<<code>string</code>, <code>string</code>></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>9</td><td>fullText</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>10</td><td>createdTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>11</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+</table><br/><p>Entity object which is used to register an entity in the system.</p>
+<li><b>entityId</b> : Client id provided by the client</li>
+<li><b>domainId</b> : Domain id</li>
+<li><b>entityTypeId</b> : Entity type id</li>
+<li><b>ownerId</b> : Owner id</li>
+<li>parentEntityId : Parent entity id</li>
+<li><b>name</b> : Name</li>
+<li>description : Short description for the entity</li>
+<li>metadata : Map of optional metadata</li>
+<li>fullText : A string which will be considered for full text search</li>
+<li>createdTime : If client provides this value then the system will use it if not the current time will be set</li>
+<li>updatedTime : If client provides this value then the system will use it if not the current time will be set</li>
+
+<br/></div><div class="definition"><h3 id="Struct_PermissionType">Struct: PermissionType</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>permissionTypeId</td><td><code>string</code></td><td></td><td>optional</td><td><code>"DO_NOT_SET_AT_CLIENTS_ID"</code></td></tr>
+<tr><td>2</td><td>domainId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>3</td><td>name</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>4</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>5</td><td>createdTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>6</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+</table><br/><p>Object for creating client defined permission type</p>
+<li>permissionTypeId : System generated permission type id. In the current implementation it will of the form domainId:name</li>
+<li><b>domainId</b> : Domain id</li>
+<li><b>name</b> : Single word name for the permission</li>
+<li>description : Short description for the permission type</li>
+<li>createdTime : Will be set by the system</li>
+<li>updatedTime : Will be set by the system</li>
+
+<br/></div><div class="definition"><h3 id="Struct_Sharing">Struct: Sharing</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>permissionTypeId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>2</td><td>entityId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>3</td><td>groupId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>4</td><td>sharingType</td><td><code><a href="#Enum_SharingType">SharingType</a></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>5</td><td>inheritedParentId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>6</td><td>createdTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>7</td><td>updatedTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr>
+</table><br/><p>This is an internal enum type for managing sharings</p>
+
+<br/></div><div class="definition"><h3 id="Struct_SharingRegistryException">Exception: SharingRegistryException</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>message</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+</table><br/><p>Exception model used in the sharing registry service</p>
+
+<br/></div></div></body></html>