saeaccess.idl

Go to the documentation of this file.

#include "sae.idl"

#pragma prefix "smgt.juniper.net"

module sae {
  const string DEFAULT_SESSION_NAME = "default";

  const string MANUAL = "MANUAL";
  
  const string ACTIVATE_ON_LOGIN = "ACTIVATE_ON_LOGIN";

  typedef sequence<wstring> WStringSeq;

  struct Attr {
    
    string name;

    WStringSeq values;
  };

  typedef sequence<Attr> AttrSeq;
  
  typedef sequence<AttrSeq> AttrSeqSeq;

  /*********************************************************************
   * Schedule objects
   */

  struct TimeSpec {
    // the attributes of time specification
    string year;                
    string month;               
    string dayOfMonth;  
    string dayOfWeek;   
    string hour;                
    string minute;      
    string extension;   
    string weeklyRecurFreq;
  };


  struct ScheduledTime {
    TimeSpec firstTimeSpec;

    TimeSpec secondTimeSpec;
  };


  struct ActionExt {
    unsigned long operation;

    wstring serviceName;
    
    AttrSeq attributes;
  };

  typedef sequence<ActionExt> ActionExtSeq;


  struct Action {
    unsigned long operation;

    wstring serviceName;
  };

  typedef sequence<Action> ActionSeq;

  typedef sequence<long long> LongLongSeq;


  struct ScheduleEntry {
     string id;                         
     ScheduledTime schedTime; 
     ActionExtSeq actions;      
        

  };
  
  typedef string ScheduleEntryId;
  
  typedef sequence<ScheduleEntryId> ScheduleEntryIdSeq;

  typedef sequence<ScheduleEntry> ScheduleEntrySeq;


  struct Select {
    
    StringSeq attributes;

    string filter;
  };


  struct IdxPair {
    unsigned long subIdx;       
    unsigned long svcIdx;       
  };

  typedef sequence<IdxPair> IdxPairSeq;

  struct ReadResult {
    IdxPairSeq result;          
    AttrSeqSeq subscription;    
    AttrSeqSeq service;         

    AttrSeq attributes;
  };
  

  /*********************************************************************
   * Exceptions raised by the interfaces
   */

  exception UnknownUserException {
    wstring userId;
    wstring message;
  };
  
  exception NonUniqueUserException {
    wstring userId;
    wstring message;
  };

  exception UnknownServiceException {
    wstring serviceName;
    wstring message;
  };

  exception UnknownServiceSessionException {
    wstring serviceName;
    wstring sessionName;
    wstring message;
  };

  exception UnknownSubscriptionException {
    wstring subscriptionName;
    wstring message;
  };

  exception SAEException {
    wstring message;
  };

  exception LoginException {
    string currentIp;
    string loginName;
    wstring message;
  };

  exception OverloadException {
    wstring message;
  };

  exception UnsupportedException {
    wstring message;
  };
  
  enum SAET {
    SAET_PUBLIC_IP_AUTHENTICATION,
    SAET_MUTEX_GROUPS,
    SAET_SERVICE_AUTHORIZATION,
    SAET_ANONYMOUS_USER,
    SAET_AUTH_PRECLUDES_ACTIVATE_ON_LOGIN,
    SAET_INHERITED_SUBSCRIPTION,
    SAET_SERVICE_UNAVAILABLE,
    SAET_SUBSCRIPTION_AUTHORIZATION,
    SAET_ACTIVATE_ONLY,
    SAET_INVISIBLE,
    SAET_FILTERED_OUT,
    SAET_NO_SESSION_MODIFICATION,
    SAET_TRANSIENT_EXCEPTION,
    SAET_PERSISTENT_ACTIVATION,
    SAET_MODIFY_EXCEPTION
  };

  exception ServiceAuthenticationException {
    SAET reason;
    wstring userIp;
    wstring serviceName;
    wstring sessionName;
    wstring message;
  };
  
  /*********************************************************************
   * SubscriberId
   */

  struct TimedAddress {
    string ipAddress;                
    unsigned long long timestamp;    

  };


  struct InterfaceName {
    string intfName;                    
    string vrName;                      
  };


  struct InterfaceIndex {
    unsigned long index;                
    string vrName;                      
  };


  struct AddrInterfaceName {
    string ipAddress;                   
    string intfName;                    
    string vrName;                      


  };
  
  struct TunnelSession {
    long tunnelId;              
    long tunnelSessionId;       
    string vrName;              

  };

  struct GlobalAddress {
    string ipAddress;
    string vpn_id;
  };

  struct GlobalLoginName {
    string login_name;                  
    string vpn_id;                      
  };

  enum SubscriberIdType {
    SIT_ADDRESS,
                        
    SIT_DN,
    
    SIT_LOGIN_NAME,
    
    SIT_IF_NAME,
    
    SIT_IF_INDEX,       
   
    SIT_PRIMARY_USER_NAME,
    
    SIT_ADDR_IF_NAME,
                    
    SIT_TUNNEL_SESSION,

    SIT_SESSIONID,          
    
    SIT_SESSION_HANDLE,

    SIT_GLOBAL_ADDRESS,

    SIT_GLOBAL_LOGIN_NAME
  };


  union SubscriberId switch(SubscriberIdType) {
    case SIT_ADDRESS:                   
      TimedAddress address;
    case SIT_DN:                        
      string dn;
    case SIT_LOGIN_NAME:                
      string login_name;
    case SIT_IF_NAME:                   
      InterfaceName if_name;
    case SIT_IF_INDEX:                  
      InterfaceIndex if_index;
    case SIT_PRIMARY_USER_NAME:         
      string primary_user_name;
    case SIT_ADDR_IF_NAME:              
      AddrInterfaceName addr_if_name;  
    case SIT_TUNNEL_SESSION:            
      TunnelSession tunnel_session;
    case SIT_SESSIONID:                 
      string sessionId;
    case SIT_SESSION_HANDLE:            
      string sessionHandle;
    case SIT_GLOBAL_ADDRESS:            
      GlobalAddress global_address;
    case SIT_GLOBAL_LOGIN_NAME:         
      GlobalLoginName global_login_name;
  };


  struct DhcpAttribute {
    string name;        
    string value;               
  };

  typedef sequence<DhcpAttribute> DhcpAttributes;


  interface Subscriber {

    
    ReadResult read(in Select subscription,
                    in Select service,
                    in StringSeq attributes)
      raises (SAEException, UnknownUserException, NonUniqueUserException);


    AttrSeq readSubscriber(in StringSeq attributes)
      raises (SAEException, UnknownUserException, NonUniqueUserException);


    AttrSeqSeq readSubscription(in Select selection)
      raises (SAEException, UnknownUserException, NonUniqueUserException);


    AttrSeqSeq readService(in Select selection)
      raises (SAEException, UnknownUserException, NonUniqueUserException);

    /*
     * Schedule manipulation for the subscriber
     */

    void addScheduleEntry(in ScheduleEntryId id,
                          in ScheduledTime schedTime,
                          in ActionExtSeq actions)
      raises (UnknownUserException,
              SAEException);


    void updateScheduleEntry(in ScheduleEntryId id,
                             in ScheduledTime schedTime,
                             in ActionExtSeq actions)
      raises (UnknownUserException,
              SAEException);


    void deleteScheduleEntry(in ScheduleEntryId id)
      raises (UnknownUserException,
              SAEException);


    ScheduleEntry getScheduleEntryById(in ScheduleEntryId id)
      raises (UnknownUserException,
              SAEException);


    ScheduleEntrySeq getScheduleEntriesByIds(in ScheduleEntryIdSeq ids)
      raises (UnknownUserException,
              SAEException);


    ScheduleEntryIdSeq getScheduleEntryIds(in long long startDate,
                                           in long long endDate)
      raises (UnknownUserException,
              SAEException);


    void addOneTimeScheduleEntry(in long long eventDate,
                                 in ActionSeq actions)
      raises (UnknownUserException,
              SAEException);


    void updateOneTimeScheduleEntryActions(in long long eventDate,
                                           in ActionSeq actions)
      raises (UnknownUserException,
              SAEException);


    void deleteOneTimeScheduleEntries(in long long startDate,
                                      in long long endDate)
      raises (UnknownUserException,
              SAEException);


    ActionSeq getOneTimeScheduleEntryActions(in long long eventDate)
      raises (UnknownUserException,
              SAEException);


    LongLongSeq getOneTimeScheduleEntryEventDates(in long long startDate,
                                                  in long long endDate)
      raises (UnknownUserException,
              SAEException);


    WStringSeq addSubscriptionAttributes(in string subscriptionName,
                                         in string userName,
                                         in string password,
                                         in AttrSeq subscriptionAttributes)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              ServiceAuthenticationException,
              SAEException);


    WStringSeq addSubscription(in string subscriptionName,
                               in string userName,
                               in string password)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              ServiceAuthenticationException,
              SAEException);


    WStringSeq deleteSubscription(in string subscriptionName,
                                  in string userName,
                                  in string password)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              UnknownSubscriptionException,
              ServiceAuthenticationException,
              SAEException);


    void setSessionTimeout(in unsigned long timeout)
      raises (UnknownUserException, NonUniqueUserException, SAEException);

    
    void updateSessionTimeout(in unsigned long timeout)
      raises (UnknownUserException, NonUniqueUserException, SAEException);  
     

    void updateServiceSessionTimeout(in string subscriptionName,
                                     in string sessionName,
                                     in unsigned long timeout)
      raises (UnknownUserException, 
              NonUniqueUserException,
              UnknownServiceException,
              UnknownSubscriptionException,
              SAEException); 

    
    boolean login(in string loginName,
                  in string password)
      raises (LoginException,
              SAEException);


    void logout()
      raises (UnknownUserException,
              SAEException);


    void disconnect()
      raises (UnknownUserException,
              NonUniqueUserException,
              UnsupportedException,
              SAEException);


    void grantPublicIp(in string loginName,
                       in string password)
      raises (UnknownUserException,
              ServiceAuthenticationException,
              SAEException);


    void grantPublicIpAttr(in string loginName,
                           in string password,
                           in DhcpAttributes attr)
      raises (UnknownUserException,
              ServiceAuthenticationException,
              SAEException);


    void revokePublicIp()
      raises (UnknownUserException,
              SAEException);


    void activateService(in string subscriptionName,
                         in string sessionName,
                         in AttrSeq activationAttributes)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              UnknownSubscriptionException,
              ServiceAuthenticationException,
              OverloadException,
              SAEException);


    string activateServiceSession(in string subscriptionName,
                                  in string sessionName,
                                  in AttrSeq activationAttributes)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              UnknownSubscriptionException,
              ServiceAuthenticationException,
              OverloadException,
              SAEException);

    
    void activateServiceBackground(in string subscriptionName,
                                   in string sessionName,
                                   in AttrSeq activationAttributes)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              UnknownSubscriptionException,
              ServiceAuthenticationException,
              OverloadException,
              SAEException);
      
    void modifyServiceSession(in string subscriptionName,
                              in string sessionName,
                              in AttrSeq activationAttributes)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              UnknownSubscriptionException,
              UnknownServiceSessionException,
              ServiceAuthenticationException,
              OverloadException,
              SAEException);

    void startModifyFragmentSession(in string subscriptionName,
                                    in string sessionName,
                                    in AttrSeq activationAttributes)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              UnknownSubscriptionException,
              UnknownServiceSessionException,
              ServiceAuthenticationException,
              SAEException);

    void finishModifyFragmentSession(in string subscriptionName,
                                     in string sessionName,
                                     in AttrSeq activationAttributes)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              UnknownSubscriptionException,
              UnknownServiceSessionException,
              ServiceAuthenticationException,
              OverloadException,
              SAEException);

    void undoModifyFragmentSession(in string subscriptionName,
                                   in string sessionName,
                                   in AttrSeq activationAttributes)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              UnknownSubscriptionException,
              UnknownServiceSessionException,
              ServiceAuthenticationException,
              OverloadException,
              SAEException);
    
    void deactivateService(in string subscriptionName,
                           in string sessionName)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              UnknownSubscriptionException,
              ServiceAuthenticationException,
              SAEException);
    
    void deactivateServiceBackground(in string subscriptionName,
                                     in string sessionName)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              UnknownSubscriptionException,
              ServiceAuthenticationException,
              SAEException);


    void deactivateServiceReason(in string subscriptionName,
                                 in string sessionName,
                                 in long reason)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              UnknownSubscriptionException,
              ServiceAuthenticationException,
              SAEException);
    
    void deactivateServiceBackgroundReason(in string subscriptionName,
                                           in string sessionName,
                                           in long reason)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              UnknownSubscriptionException,
              ServiceAuthenticationException,
              SAEException);

    void fragmentDown(in string aggregateSubscriptionName,
                      in string aggregateSessionName,
                      in string fragmentSessionId)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              UnknownSubscriptionException,
              UnknownServiceSessionException,
              SAEException);

    void fragmentReactivating(in string aggregateSubscriptionName,
                              in string aggregateSessionName,
                              in string fragmentSessionId)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              UnknownSubscriptionException,
              UnknownServiceSessionException,
              SAEException);


    void setActivationTrigger(in string subscriptionName,
                              in string activationTrigger)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              UnknownSubscriptionException,
              ServiceAuthenticationException,
              SAEException);


    void setPersistentSession(in string subscriptionName,
                              in string sessionName,
                              in AttrSeq persistentSessionAttributes)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              SAEException);


    void deletePersistentSession(in string subscriptionName,
                                 in string sessionName)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              SAEException);

                                 
    void modifyPersistentSession(in string subscriptionName,
                                 in string sessionName,
                                 in boolean active)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              SAEException);


    void setInterimTime(in string subscriptionName,
                        in string sessionName,
                        in unsigned long time)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              SAEException);

                                 
    void setSessionVolumeQuota(in string subscriptionName,
                               in string sessionName,
                               in string sessionVolumeQuota)
      raises (UnknownUserException,
              NonUniqueUserException,
              UnknownServiceException,
              SAEException);


    AttrSeqSeq getUsage(in Select selection)
      raises (SAEException,
              UnknownUserException,
              NonUniqueUserException,
              OverloadException);
    
    void setProperty(in string aProperty)
      raises (SAEException,
              UnknownUserException,
              NonUniqueUserException);
  };

 
  typedef sequence<Subscriber> SubscriberSeq;


  struct Registration {
    string macAddress;          
    string loginName;           
    string userDn;              
    string intfName;
    string vrName;
    wstring description;
                              
  };

  typedef sequence<Registration> RegistrationSeq;

  interface SubscriberIterator {


    SubscriberSeq next_n(in unsigned long how_many,
                         out boolean more);


    void destroy();
  };

 
  interface SAEAccess: SAEFeature {
   

    Subscriber getSubscriber(in SubscriberId sid)
      raises (UnknownUserException, NonUniqueUserException);


    SubscriberSeq getSubscriberSet(in SubscriberId sid,
                                   in unsigned long how_many,
                                   out SubscriberIterator iter,
                                   out unsigned long total);


    SubscriberSeq findSubscriber(in string filter,
                                 in unsigned long how_many,
                                 out SubscriberIterator iter,
                                 out unsigned long total)
      raises (SAEException);


    SubscriberSeq getSubscriberFilter(in SubscriberId sid,
                                      in string filter,
                                      in unsigned long how_many,
                                      out SubscriberIterator iter,
                                      out unsigned long total)
      raises (SAEException);


    // manipulate ServiceActivationEngine


    void registerLogin(in string macAddress,
                       in wstring loginDescription,
                       in string loginName,
                       in string password,
                       in string vrName,
                       in string interfaceName)
      raises (LoginException, SAEException);


    void registerLoginCredentials(in string macAddress,
                                  in wstring loginDescription,
                                  in string loginName,
                                  in string password,
                                  in string vrName,
                                  in string interfaceName)
      raises (LoginException, SAEException);


    void registerNextLogin(in string macAddress,
                           in wstring loginDescription,
                           in string loginName,
                           in string password,
                           in string vrName,
                           in string interfaceName)
      raises (LoginException, SAEException);


    void unregisterLogin(in string macAddress,
                         in string loginName,
                         in string password)
      raises (LoginException, SAEException);


    void registerEquipment(in string macAddress,
                           in wstring equipmentDescription,
                           in string loginName,
                           in string password,
                           in string vrName,
                           in string interfaceName)
      raises (SAEException);


    void registerEquipmentAttr(in string macAddress,
                               in wstring equipmentDescription,
                               in string loginName,
                               in string password,
                               in string vrName,
                               in string interfaceName,
                               in DhcpAttributes attr)
      raises (SAEException);


    void unregisterEquipment(in string macAddress,
                             in string loginName,
                             in string password)
      raises (SAEException);


    boolean loginUser(in string userIp,
                      in string loginName,
                      in string password)
      raises (LoginException, SAEException);


    RegistrationSeq getRegisteredLogins(in string login,
                                        in string password)
      raises(LoginException, SAEException);


    RegistrationSeq getRegisteredEquipment(in string login,
                                           in string password)
      raises(LoginException, SAEException);

  };
};

---