stack/core/src/main/java/org/apache/usergrid/persistence/entities/Application.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.usergrid.persistence.entities;


import java.io.Serializable;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;

import javax.xml.bind.annotation.XmlRootElement;

import org.apache.usergrid.persistence.TypedEntity;
import org.apache.usergrid.persistence.annotations.EntityCollection;
import org.apache.usergrid.persistence.annotations.EntityDictionary;
import org.apache.usergrid.persistence.annotations.EntityProperty;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize.Inclusion;

/** Applications represent the topmost container for all entities. */
@XmlRootElement
public class Application extends TypedEntity implements Serializable {

    public static final String ENTITY_TYPE = "application";

    public static final String COLLECTION_USERS = "users";

    public static final String COLLECTION_GROUPS = "groups";

    public static final String COLLECTION_ASSETS = "assets";

    public static final String COLLECTION_ACTIVITIES = "activities";

    public static final String COLLECTION_EVENTS = "events";

    public static final String COLLECTION_FOLDERS = "folders";

    public static final String COLLECTION_DEVICES = "devices";

    public static final String COLLECTION_NOTIFICATIONS = "notifications";

    public static final String COLLECTION_ROLES = "roles";

    public static boolean isCustomCollectionName(String collectionName) {
        switch (collectionName.toLowerCase()) {
            case COLLECTION_USERS:
            case COLLECTION_GROUPS:
            case COLLECTION_ASSETS:
            case COLLECTION_ACTIVITIES:
            case COLLECTION_EVENTS:
            case COLLECTION_FOLDERS:
            case COLLECTION_DEVICES:
            case COLLECTION_NOTIFICATIONS:
            case COLLECTION_ROLES:
                return false;
        }
        return true;
    }

    @EntityProperty(indexed = true, fulltextIndexed = false, required = true, mutable = false, aliasProperty = true,
            basic = true)
    protected String name;

    @EntityProperty(basic = true, indexed = false)
    protected String title;

    @EntityProperty(basic = true, indexed = false)
    protected Long accesstokenttl;

    @EntityProperty(indexed = false)
    protected String description;

    @EntityDictionary(keyType = java.lang.String.class)
    protected Set<String> collections;

    @EntityDictionary(keyType = java.lang.String.class, valueType = java.lang.String.class)
    protected Map<String, String> rolenames;

    @EntityDictionary(keyType = java.lang.String.class)
    protected Set<String> counters;

    @EntityProperty(indexed = false)
    protected Boolean activated;

    @EntityProperty(indexed = false)
    protected Boolean disabled;

    @EntityProperty(name = "allow_open_registration", indexed = false)
    protected Boolean allowOpenRegistration;

    @EntityProperty(name = "registration_requires_email_confirmation", indexed = false)
    protected Boolean registrationRequiresEmailConfirmation;

    @EntityProperty(name = "registration_requires_admin_approval", indexed = false)
    protected Boolean registrationRequiresAdminApproval;

    @EntityProperty(name = "notify_admin_of_new_users", indexed = false)
    protected Boolean notifyAdminOfNewUsers;

    @EntityDictionary(keyType = java.lang.String.class, valueType = OAuthProvider.class)
    protected Map<String, OAuthProvider> oauthproviders;

    @EntityDictionary(keyType = java.lang.String.class, valueType = java.lang.String.class)
    protected Map<String, String> credentials;

    @EntityDictionary(keyType = java.lang.String.class, valueType = WebHook.class)
    protected Map<String, WebHook> webhooks;

    @EntityCollection(type = "activity", reversed = true, sort = "published desc", indexingDynamicDictionaries = true)
    protected List<UUID> activities;

    @EntityCollection(type = "asset", indexingDynamicDictionaries = true)
    protected List<UUID> assets;

    @EntityCollection(type = "event", indexingDynamicDictionaries = true)
    protected List<UUID> events;

    @EntityCollection(type = "folder", indexingDynamicDictionaries = true)
    protected List<UUID> folders;

    @EntityCollection(type = "group")
    protected List<UUID> groups;

    @EntityCollection(type = "user", dictionariesIndexed = { "aliases" })
    protected List<UUID> users;

    @EntityCollection(type = "device")
    protected List<UUID> devices;

    @EntityCollection(type = "notification")
    protected List<UUID> notifications;


    public Application() {
        // id = UUIDUtils.newTimeUUID();
    }


    public Application( UUID id ) {
        uuid = id;
    }


    @Override
    @JsonSerialize(include = Inclusion.NON_NULL)
    public String getName() {
        return name;
    }


    public void setName( String name ) {
        this.name = name;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    public String getTitle() {
        return title;
    }


    public void setTitle( String title ) {
        this.title = title;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    public String getDescription() {
        return description;
    }


    public void setDescription( String description ) {
        this.description = description;
    }


    public boolean activated() {
        return ( activated != null ) && activated;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    public Boolean getActivated() {
        return activated;
    }


    public void setActivated( Boolean activated ) {
        this.activated = activated;
    }


    public boolean disabled() {
        return ( disabled != null ) && disabled;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    public Boolean getDisabled() {
        return disabled;
    }


    public void setDisabled( Boolean disabled ) {
        this.disabled = disabled;
    }


    public boolean allowOpenRegistration() {
        return ( allowOpenRegistration != null ) && allowOpenRegistration;
    }


    @JsonProperty("allow_open_registration")
    @JsonSerialize(include = Inclusion.NON_NULL)
    public Boolean getAllowOpenRegistration() {
        return allowOpenRegistration;
    }


    @JsonProperty("allow_open_registration")
    public void setAllowOpenRegistration( Boolean allowOpenRegistration ) {
        this.allowOpenRegistration = allowOpenRegistration;
    }


    public boolean registrationRequiresEmailConfirmation() {
        return ( registrationRequiresEmailConfirmation != null ) && registrationRequiresEmailConfirmation;
    }


    @JsonProperty("registration_requires_email_confirmation")
    @JsonSerialize(include = Inclusion.NON_NULL)
    public Boolean getRegistrationRequiresEmailConfirmation() {
        return registrationRequiresEmailConfirmation;
    }


    @JsonProperty("registration_requires_email_confirmation")
    public void setRegistrationRequiresEmailConfirmation( Boolean registrationRequiresEmailConfirmation ) {
        this.registrationRequiresEmailConfirmation = registrationRequiresEmailConfirmation;
    }


    public boolean registrationRequiresAdminApproval() {
        return ( registrationRequiresAdminApproval != null ) && registrationRequiresAdminApproval;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    @JsonProperty("registration_requires_admin_approval")
    public Boolean getRegistrationRequiresAdminApproval() {
        return registrationRequiresAdminApproval;
    }


    @JsonProperty("registration_requires_admin_approval")
    public void setRegistrationRequiresAdminApproval( Boolean registrationRequiresAdminApproval ) {
        this.registrationRequiresAdminApproval = registrationRequiresAdminApproval;
    }


    public boolean notifyAdminOfNewUsers() {
        return ( notifyAdminOfNewUsers != null ) && notifyAdminOfNewUsers;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    @JsonProperty("notify_admin_of_new_users")
    public Boolean getNotifyAdminOfNewUsers() {
        return notifyAdminOfNewUsers;
    }


    @JsonProperty("notify_admin_of_new_users")
    public void setNotifyAdminOfNewUsers( Boolean notifyAdminOfNewUsers ) {
        this.notifyAdminOfNewUsers = notifyAdminOfNewUsers;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    public List<UUID> getUsers() {
        return users;
    }


    public void setUsers( List<UUID> users ) {
        this.users = users;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    public List<UUID> getGroups() {
        return groups;
    }


    public void setGroups( List<UUID> groups ) {
        this.groups = groups;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    public Set<String> getCollections() {
        return collections;
    }


    public void setCollections( Set<String> collections ) {
        this.collections = collections;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    public Map<String, String> getRolenames() {
        return rolenames;
    }


    public void setRolenames( Map<String, String> rolenames ) {
        this.rolenames = rolenames;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    public Set<String> getCounters() {
        return counters;
    }


    public void setCounters( Set<String> counters ) {
        this.counters = counters;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    public List<UUID> getAssets() {
        return assets;
    }


    public void setAssets( List<UUID> assets ) {
        this.assets = assets;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    public Map<String, String> getCredentials() {
        return credentials;
    }


    public void setCredentials( Map<String, String> credentials ) {
        this.credentials = credentials;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    public List<UUID> getActivities() {
        return activities;
    }


    public void setActivities( List<UUID> activities ) {
        this.activities = activities;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    public List<UUID> getFolders() {
        return folders;
    }


    public void setFolders( List<UUID> folders ) {
        this.folders = folders;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    public List<UUID> getEvents() {
        return events;
    }


    public void setEvents( List<UUID> events ) {
        this.events = events;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    public List<UUID> getDevices() {
        return devices;
    }


    public void setDevices( List<UUID> devices ) {
        this.devices = devices;
    }


    @JsonSerialize(include = Inclusion.NON_NULL)
    public Map<String, OAuthProvider> getOauthproviders() {
        return oauthproviders;
    }


    public void setOauthproviders( Map<String, OAuthProvider> oauthproviders ) {
        this.oauthproviders = oauthproviders;
    }


    /** Get the organization name of this app */
    public String getOrganizationName() {
        String[] names = name.split( "/" );

        if ( names.length == 2 ) {
            return names[0];
        }

        return null;
    }


    /** Get the application name of this app */
    public String getApplicationName() {
        String[] names = name.split( "/" );

        if ( names.length == 2 ) {
            return names[1];
        }

        return null;
    }


    /** @return the accesstokenttl */
    public Long getAccesstokenttl() {
        return accesstokenttl;
    }


    /** @param accesstokenttl the accesstokenttl to set */
    public void setAccesstokenttl( Long accesstokenttl ) {
        this.accesstokenttl = accesstokenttl;
    }


    @XmlRootElement
    public static class OAuthProvider implements Serializable {
        String clientId;
        String clientSecret;
        String redirectUris;
        String javaScriptOrigins;
        String authorizationEndpointUrl;
        String accessTokenEndpointUrl;
        String requestTokenEndpointUrl;
        String version = "1.0a";


        public OAuthProvider() {
        }


        public OAuthProvider( String clientId, String clientSecret ) {
            this.clientId = clientId;
            this.clientSecret = clientSecret;
        }


        public OAuthProvider( String clientId, String clientSecret, String redirectUris, String javaScriptOrigins ) {
            this.clientId = clientId;
            this.clientSecret = clientSecret;
            this.redirectUris = redirectUris;
            this.javaScriptOrigins = javaScriptOrigins;
        }


        public OAuthProvider( String clientId, String clientSecret, String redirectUris, String javaScriptOrigins,
                              String authorizationEndpointUrl, String accessTokenEndpointUrl,
                              String requestTokenEndpointUrl ) {
            this.clientId = clientId;
            this.clientSecret = clientSecret;
            this.redirectUris = redirectUris;
            this.javaScriptOrigins = javaScriptOrigins;
            this.authorizationEndpointUrl = authorizationEndpointUrl;
            this.accessTokenEndpointUrl = accessTokenEndpointUrl;
            this.requestTokenEndpointUrl = requestTokenEndpointUrl;
        }


        @JsonSerialize(include = Inclusion.NON_NULL)
        public String getVersion() {
            return version;
        }


        public void setVersion( String version ) {
            this.version = version;
        }


        @JsonSerialize(include = Inclusion.NON_NULL)
        public String getClientId() {
            return clientId;
        }


        public void setClientId( String clientId ) {
            this.clientId = clientId;
        }


        @JsonSerialize(include = Inclusion.NON_NULL)
        public String getClientSecret() {
            return clientSecret;
        }


        public void setClientSecret( String clientSecret ) {
            this.clientSecret = clientSecret;
        }


        @JsonSerialize(include = Inclusion.NON_NULL)
        public String getRedirectUris() {
            return redirectUris;
        }


        public void setRedirectUris( String redirectUris ) {
            this.redirectUris = redirectUris;
        }


        @JsonSerialize(include = Inclusion.NON_NULL)
        public String getJavaScriptOrigins() {
            return javaScriptOrigins;
        }


        public void setJavaScriptOrigins( String javaScriptOrigins ) {
            this.javaScriptOrigins = javaScriptOrigins;
        }


        @JsonSerialize(include = Inclusion.NON_NULL)
        public String getAuthorizationEndpointUrl() {
            return authorizationEndpointUrl;
        }


        public void setAuthorizationEndpointUrl( String authorizationEndpointUrl ) {
            this.authorizationEndpointUrl = authorizationEndpointUrl;
        }


        @JsonSerialize(include = Inclusion.NON_NULL)
        public String getAccessTokenEndpointUrl() {
            return accessTokenEndpointUrl;
        }


        public void setAccessTokenEndpointUrl( String accessTokenEndpointUrl ) {
            this.accessTokenEndpointUrl = accessTokenEndpointUrl;
        }


        @JsonSerialize(include = Inclusion.NON_NULL)
        public String getRequestTokenEndpointUrl() {
            return requestTokenEndpointUrl;
        }


        public void setRequestTokenEndpointUrl( String requestTokenEndpointUrl ) {
            this.requestTokenEndpointUrl = requestTokenEndpointUrl;
        }


        @Override
        public String toString() {
            return "OAuthProvider [clientId=" + clientId + ", clientSecret=" + clientSecret + ", redirectUris="
                    + redirectUris + ", javaScriptOrigins=" + javaScriptOrigins + ", authorizationEndpointUrl="
                    + authorizationEndpointUrl + ", accessTokenEndpointUrl=" + accessTokenEndpointUrl
                    + ", requestTokenEndpointUrl=" + requestTokenEndpointUrl + ", version=" + version + "]";
        }
    }


    @XmlRootElement
    public static class WebHook {
        String type;
        String uri;


        public WebHook() {
        }


        public String getType() {
            return type;
        }


        public void setType( String type ) {
            this.type = type;
        }


        public String getUri() {
            return uri;
        }


        public void setUri( String uri ) {
            this.uri = uri;
        }
    }
}