/*
 * $RCSfile: Transient.java,v $
 * $Revision: 1.15.6.2 $
 * $Date: 2015/04/29 15:48:53 $
 *
 * Copyright 2013 Cloud Software Group, Inc. ALL RIGHTS RESERVED. 
 * Cloud Software Group, Inc. Confidential Information
 */
package com.tibco.xp.runtime;

import com.kabira.platform.ObjectNotUniqueError;
import com.kabira.platform.ResourceUnavailableException;
import com.tibco.cep.runtime.model.event.EventContext;
import com.tibco.cep.runtime.model.event.impl.SimpleEventImpl;

/**
 * Base class for transient events.
 * <p>
 * A transient event is one that has a TTL of 0.  It is
 * not stored in shared memory and is automatically 
 * destroyed at the end of the RTC
 */
public abstract class Transient extends Event 
{
        /**
         * Java constructor
         */
        protected Transient()
        {
        }
        
        /**
         * Rule or Rule Function constructor
         * @param id Unique identifier
         */
        protected Transient(long id)
        {
            register(id);
        }
        
        @Override
        public String toString()
        {
                StringBuilder value = new StringBuilder(super.toString());

                value.append("&context=");
                value.append(Transient.getChannelContext(this));
                
                return value.toString();
        }
        
        @Override
        public final void delete()
        {
                // Delete is a noop for transient events
        }
        
        @Override
        public final Boolean getRetryOnException() 
        {
                return m_retryOnException;
        }

        @Override
        public final Long getTimeToLive() 
        {
                return m_timeToLive;
        }

        @Override
        public final String getTimeToLiveUnits() 
        {
                return m_timeToLiveUnits;
        }
        
        @Override
        public final void assertEvent() throws ObjectNotUniqueError, ResourceUnavailableException
        {
                // TODO - Work-around for FLUENCY-5593. 
                super.assertEvent();
        }
        
        @Override
        protected final void setRetryOnException(Boolean retryOnException) 
        {
                m_retryOnException = retryOnException;
        }

        @Override
        public final PayLoad getPayLoad() 
        {
                return m_payload;
        }
        
        /**
         * Update user properties from shared memory
         * @param eventImpl Event handle to update
         */
        protected abstract void updateUserProperties(SimpleEventImpl eventImpl);

        @Override
        protected final void updatePayLoad(PayLoad payload) 
        {
                m_payload = payload;
        }

        @Override
        protected final void setTimeToLive(Long timeToLive) 
        {
                assert timeToLive == 0 : timeToLive;
                m_timeToLive = timeToLive;
        }

        @Override
        protected final void setTimeToLiveUnits(String timeToLiveUnits) 
        {
                m_timeToLiveUnits = timeToLiveUnits;
        }
        
        @Override
        public final void setDestination(final String destination) 
        {
                enforceDispatchState();
                
                if (destination == null)
                {
                        throw new IllegalArgumentException("Destination cannot be null");
                }

                m_destination = destination;
        }
        
        @Override
        public final String getDestination() 
        {
                return m_destination;
        }

        @Override
        protected final Boolean getDispatched() 
        {
                return m_dispatched;
        }

        @Override
        protected final void setDispatched() 
        {
                m_dispatched = true;
        }
        
        @Override
        final String getTimerIdentifier()
        {
                return _INVALID_TIMER_IDENTIFIER;
        }
        
        @Override
        final void setTimerIdentifier(final String identifier)
        {
                assert false : identifier;
        }
        
        @Override
        protected final void updateProperties()
        {
                assert EntityProxy.getProxy(this) instanceof EventProxy : this;
        assert getHandle(false) instanceof SimpleEventImpl : this;
        
        EventProxy proxy = (EventProxy)EntityProxy.getProxy(this);
        SimpleEventImpl handle = (SimpleEventImpl) getHandle(false);

                proxy.updateMetaProperties(handle);
                updateUserProperties(handle);
        }
    
        /**
         * Get the channel context for an event
         * @param event Event event
         * @return Channel context for this event, may be null
         * <p>
         * N.B. This method is static to be consistent with the
         * non-transient event method.
         */
        static final EventContext getChannelContext(Transient event) 
        {
                assert event != null;
                return event.m_context;
        }

        /**
         * Set the channel context for an event
         * @param event Event
         * @param context Channel context to set, may be null
         * <p>
         * N.B. This method is static to be consistent with the
         * non-transient event method.
         */
        static final void setChannelContext(Transient event, EventContext context) 
        {
                assert event != null;
                event.m_context = context;
        }

        private boolean  m_dispatched = false;
        private boolean  m_retryOnException = _DEFAULT_RETRY_ON_EXCEPTION;
        private long     m_timeToLive = _DEFAULT_TIME_TO_LIVE;
        private String   m_timeToLiveUnits = _TIME_TO_LIVE_UNITS_DEFAULT;
        private PayLoad  m_payload = null;
        private String   m_destination = null;
        private EventContext m_context = null;
        private static final long serialVersionUID = 4L;
}