NUContainer.j

/*
  Copyright (c) 2015, Alcatel-Lucent Inc
  All rights reserved.

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are met:
      * Redistributions of source code must retain the above copyright
        notice, this list of conditions and the following disclaimer.
      * Redistributions in binary form must reproduce the above copyright
        notice, this list of conditions and the following disclaimer in the
        documentation and/or other materials provided with the distribution.
      * Neither the name of the copyright holder nor the names of its contributors
        may be used to endorse or promote products derived from this software without
        specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

@import <Foundation/Foundation.j>
@import <AppKit/CPArrayController.j>
@import <Bambou/NURESTObject.j>

@import "Fetchers/NUPermissionsFetcher.j"
@import "Fetchers/NUMetadatasFetcher.j"
@import "Fetchers/NUAlarmsFetcher.j"
@import "Fetchers/NUGlobalMetadatasFetcher.j"
@import "Fetchers/NUContainerInterfacesFetcher.j"
@import "Fetchers/NUContainerResyncsFetcher.j"
@import "Fetchers/NUVRSsFetcher.j"
@import "Fetchers/NUEventLogsFetcher.j"

NUContainerDeleteMode_TIMER = @"TIMER";
NUContainerEntityScope_ENTERPRISE = @"ENTERPRISE";
NUContainerEntityScope_GLOBAL = @"GLOBAL";
NUContainerReasonType_BLOCKED_LAST = @"BLOCKED_LAST";
NUContainerReasonType_BLOCKED_UNKNOWN = @"BLOCKED_UNKNOWN";
NUContainerReasonType_CRASHED_LAST = @"CRASHED_LAST";
NUContainerReasonType_CRASHED_UNKNOWN = @"CRASHED_UNKNOWN";
NUContainerReasonType_NOSTATE_LAST = @"NOSTATE_LAST";
NUContainerReasonType_NOSTATE_UNKNOWN = @"NOSTATE_UNKNOWN";
NUContainerReasonType_PAUSED_DUMP = @"PAUSED_DUMP";
NUContainerReasonType_PAUSED_FROM_SNAPSHOT = @"PAUSED_FROM_SNAPSHOT";
NUContainerReasonType_PAUSED_IOERROR = @"PAUSED_IOERROR";
NUContainerReasonType_PAUSED_LAST = @"PAUSED_LAST";
NUContainerReasonType_PAUSED_MIGRATION = @"PAUSED_MIGRATION";
NUContainerReasonType_PAUSED_SAVE = @"PAUSED_SAVE";
NUContainerReasonType_PAUSED_SHUTTING_DOWN = @"PAUSED_SHUTTING_DOWN";
NUContainerReasonType_PAUSED_UNKNOWN = @"PAUSED_UNKNOWN";
NUContainerReasonType_PAUSED_USER = @"PAUSED_USER";
NUContainerReasonType_PAUSED_WATCHDOG = @"PAUSED_WATCHDOG";
NUContainerReasonType_RUNNING_BOOTED = @"RUNNING_BOOTED";
NUContainerReasonType_RUNNING_FROM_SNAPSHOT = @"RUNNING_FROM_SNAPSHOT";
NUContainerReasonType_RUNNING_LAST = @"RUNNING_LAST";
NUContainerReasonType_RUNNING_MIGRATED = @"RUNNING_MIGRATED";
NUContainerReasonType_RUNNING_MIGRATION_CANCELED = @"RUNNING_MIGRATION_CANCELED";
NUContainerReasonType_RUNNING_RESTORED = @"RUNNING_RESTORED";
NUContainerReasonType_RUNNING_SAVE_CANCELED = @"RUNNING_SAVE_CANCELED";
NUContainerReasonType_RUNNING_UNKNOWN = @"RUNNING_UNKNOWN";
NUContainerReasonType_RUNNING_UNPAUSED = @"RUNNING_UNPAUSED";
NUContainerReasonType_SHUTDOWN_LAST = @"SHUTDOWN_LAST";
NUContainerReasonType_SHUTDOWN_UNKNOWN = @"SHUTDOWN_UNKNOWN";
NUContainerReasonType_SHUTDOWN_USER = @"SHUTDOWN_USER";
NUContainerReasonType_SHUTOFF_CRASHED = @"SHUTOFF_CRASHED";
NUContainerReasonType_SHUTOFF_DESTROYED = @"SHUTOFF_DESTROYED";
NUContainerReasonType_SHUTOFF_FAILED = @"SHUTOFF_FAILED";
NUContainerReasonType_SHUTOFF_FROM_SNAPSHOT = @"SHUTOFF_FROM_SNAPSHOT";
NUContainerReasonType_SHUTOFF_LAST = @"SHUTOFF_LAST";
NUContainerReasonType_SHUTOFF_MIGRATED = @"SHUTOFF_MIGRATED";
NUContainerReasonType_SHUTOFF_SAVED = @"SHUTOFF_SAVED";
NUContainerReasonType_SHUTOFF_SHUTDOWN = @"SHUTOFF_SHUTDOWN";
NUContainerReasonType_SHUTOFF_UNKNOWN = @"SHUTOFF_UNKNOWN";
NUContainerReasonType_UNKNOWN = @"UNKNOWN";
NUContainerStatus_BLOCKED = @"BLOCKED";
NUContainerStatus_CRASHED = @"CRASHED";
NUContainerStatus_DELETE_PENDING = @"DELETE_PENDING";
NUContainerStatus_INIT = @"INIT";
NUContainerStatus_LAST = @"LAST";
NUContainerStatus_NOSTATE = @"NOSTATE";
NUContainerStatus_PAUSED = @"PAUSED";
NUContainerStatus_RUNNING = @"RUNNING";
NUContainerStatus_SHUTDOWN = @"SHUTDOWN";
NUContainerStatus_SHUTOFF = @"SHUTOFF";
NUContainerStatus_UNKNOWN = @"UNKNOWN";
NUContainerStatus_UNREACHABLE = @"UNREACHABLE";


/*!
    API that can retrieve the containers associated with a domain, zone or subnet for mediation created containers for REST created  containers you need to set the additional proxy user header in http request : X-Nuage-ProxyUservalue of the header has to be either :1) enterpriseName@UserName (example : Nokia@bob), or 2) external ID of user in VSD, typically is UUID generally decided by the CMS tool in questionUser needs to have CMS privileges to use proxy user header.
*/
@implementation NUContainer : NURESTObject
{
    /*!
        Array of IDs of the l2 domain that the container is connected to
    */
    CPArrayController _l2DomainIDs @accessors(property=l2DomainIDs);
    /*!
        Id of the VRS that this container is attached to.
    */
    CPString _VRSID @accessors(property=VRSID);
    /*!
        UUID of the container
    */
    CPString _UUID @accessors(property=UUID);
    /*!
        Name of the container
    */
    CPString _name @accessors(property=name);
    /*!
        ID of the user who last updated the object.
    */
    CPString _lastUpdatedBy @accessors(property=lastUpdatedBy);
    /*!
        Time stamp when this object was last updated.
    */
    CPString _lastUpdatedDate @accessors(property=lastUpdatedDate);
    /*!
        Reason of the event associated with the container.
    */
    CPString _reasonType @accessors(property=reasonType);
    /*!
        reflects the  container Deletion expiry timer in secs , deleteMode needs to be non-null value for deleteExpiry to be taken in to effect. CMS created containers will always have deleteMode set to TIMER
    */
    CPNumber _deleteExpiry @accessors(property=deleteExpiry);
    /*!
        reflects the mode of container Deletion -  TIMER  Possible values are TIMER, .
    */
    CPString _deleteMode @accessors(property=deleteMode);
    /*!
        Information of the status of the resync operation of a container
    */
    NURESTObject _resyncInfo @accessors(property=resyncInfo);
    /*!
        This property specifies the site the container belongs to, for Geo-redundancy.
    */
    CPString _siteIdentifier @accessors(property=siteIdentifier);
    /*!
        Id of the container image
    */
    CPString _imageID @accessors(property=imageID);
    /*!
        Name of the container image
    */
    CPString _imageName @accessors(property=imageName);
    /*!
        Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.
    */
    CPArrayController _embeddedMetadata @accessors(property=embeddedMetadata);
    /*!
        List of container interfaces associated with the container
    */
    CPArrayController _interfaces @accessors(property=interfaces);
    /*!
        ID of the enterprise that this container belongs to
    */
    CPString _enterpriseID @accessors(property=enterpriseID);
    /*!
        Name of the enterprise that this container belongs to
    */
    CPString _enterpriseName @accessors(property=enterpriseName);
    /*!
        Specify if scope of entity is Data center or Enterprise level
    */
    CPString _entityScope @accessors(property=entityScope);
    /*!
        Array of IDs of the domain that the container is connected to
    */
    CPArrayController _domainIDs @accessors(property=domainIDs);
    /*!
        Compute Provisioned
    */
    BOOL _computeProvisioned @accessors(property=computeProvisioned);
    /*!
        Array of IDs of the zone that this container is attached to
    */
    CPArrayController _zoneIDs @accessors(property=zoneIDs);
    /*!
        Orchestration ID
    */
    CPString _orchestrationID @accessors(property=orchestrationID);
    /*!
        Time stamp when this object was created.
    */
    CPString _creationDate @accessors(property=creationDate);
    /*!
        Release version of VRS, which is used to determine the feature capabilties of VRS.
    */
    CPString _vrsRawVersion @accessors(property=vrsRawVersion);
    /*!
        Interpreted version of VRS, which is used to determine the feature capabilities of VRS.
    */
    CPString _vrsVersion @accessors(property=vrsVersion);
    /*!
        ID of the user that created this container
    */
    CPString _userID @accessors(property=userID);
    /*!
        Username of the user that created this container
    */
    CPString _userName @accessors(property=userName);
    /*!
        Status of the container.
    */
    CPString _status @accessors(property=status);
    /*!
        Array of IDs of the subnets that the container is connected to
    */
    CPArrayController _subnetIDs @accessors(property=subnetIDs);
    /*!
        Identifies the user that has created this object.
    */
    CPString _owner @accessors(property=owner);
    /*!
        External object ID. Used for integration with third party systems
    */
    CPString _externalID @accessors(property=externalID);
    /*!
        IP address of the hypervisor that this container is currently running in
    */
    CPString _hypervisorIP @accessors(property=hypervisorIP);
    
    NUPermissionsFetcher _childrenPermissions @accessors(property=childrenPermissions);
    NUMetadatasFetcher _childrenMetadatas @accessors(property=childrenMetadatas);
    NUAlarmsFetcher _childrenAlarms @accessors(property=childrenAlarms);
    NUGlobalMetadatasFetcher _childrenGlobalMetadatas @accessors(property=childrenGlobalMetadatas);
    NUContainerInterfacesFetcher _childrenContainerInterfaces @accessors(property=childrenContainerInterfaces);
    NUContainerResyncsFetcher _childrenContainerResyncs @accessors(property=childrenContainerResyncs);
    NUVRSsFetcher _childrenVRSs @accessors(property=childrenVRSs);
    NUEventLogsFetcher _childrenEventLogs @accessors(property=childrenEventLogs);
    
}


#pragma mark -
#pragma mark Class Method

+ (CPString)RESTName
{
    return @"container";
}


#pragma mark -
#pragma mark Initialization

- (id)init
{
    if (self = [super init])
    {
        [self exposeLocalKeyPathToREST:@"l2DomainIDs"];
        [self exposeLocalKeyPathToREST:@"VRSID"];
        [self exposeLocalKeyPathToREST:@"UUID"];
        [self exposeLocalKeyPathToREST:@"name"];
        [self exposeLocalKeyPathToREST:@"lastUpdatedBy"];
        [self exposeLocalKeyPathToREST:@"lastUpdatedDate"];
        [self exposeLocalKeyPathToREST:@"reasonType"];
        [self exposeLocalKeyPathToREST:@"deleteExpiry"];
        [self exposeLocalKeyPathToREST:@"deleteMode"];
        [self exposeLocalKeyPathToREST:@"resyncInfo"];
        [self exposeLocalKeyPathToREST:@"siteIdentifier"];
        [self exposeLocalKeyPathToREST:@"imageID"];
        [self exposeLocalKeyPathToREST:@"imageName"];
        [self exposeLocalKeyPathToREST:@"embeddedMetadata"];
        [self exposeLocalKeyPathToREST:@"interfaces"];
        [self exposeLocalKeyPathToREST:@"enterpriseID"];
        [self exposeLocalKeyPathToREST:@"enterpriseName"];
        [self exposeLocalKeyPathToREST:@"entityScope"];
        [self exposeLocalKeyPathToREST:@"domainIDs"];
        [self exposeLocalKeyPathToREST:@"computeProvisioned"];
        [self exposeLocalKeyPathToREST:@"zoneIDs"];
        [self exposeLocalKeyPathToREST:@"orchestrationID"];
        [self exposeLocalKeyPathToREST:@"creationDate"];
        [self exposeLocalKeyPathToREST:@"vrsRawVersion"];
        [self exposeLocalKeyPathToREST:@"vrsVersion"];
        [self exposeLocalKeyPathToREST:@"userID"];
        [self exposeLocalKeyPathToREST:@"userName"];
        [self exposeLocalKeyPathToREST:@"status"];
        [self exposeLocalKeyPathToREST:@"subnetIDs"];
        [self exposeLocalKeyPathToREST:@"owner"];
        [self exposeLocalKeyPathToREST:@"externalID"];
        [self exposeLocalKeyPathToREST:@"hypervisorIP"];
        
        _childrenPermissions = [NUPermissionsFetcher fetcherWithParentObject:self];
        _childrenMetadatas = [NUMetadatasFetcher fetcherWithParentObject:self];
        _childrenAlarms = [NUAlarmsFetcher fetcherWithParentObject:self];
        _childrenGlobalMetadatas = [NUGlobalMetadatasFetcher fetcherWithParentObject:self];
        _childrenContainerInterfaces = [NUContainerInterfacesFetcher fetcherWithParentObject:self];
        _childrenContainerResyncs = [NUContainerResyncsFetcher fetcherWithParentObject:self];
        _childrenVRSs = [NUVRSsFetcher fetcherWithParentObject:self];
        _childrenEventLogs = [NUEventLogsFetcher fetcherWithParentObject:self];
        
        
    }

    return self;
}

@end