Core API 7.6

net.juniper.smgt.sae.portal
Class ServiceAuthenticationException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by net.juniper.smgt.sae.portal.PortalException
              extended by net.juniper.smgt.sae.portal.SspException
                  extended by net.juniper.smgt.sae.portal.ServiceAuthenticationException
All Implemented Interfaces:
Serializable

public class ServiceAuthenticationException
extends SspException

This exception is thrown when an attempt to activate or modify a Subscription is rejected, or when an attempt to grant a public IP address fails due to an authentication failure, or when an attempt to user self subscription or user self unsubscription is denied by the subscription authorization plug-in, or when the user attempts to self subscribe to a service loaded to ssp but unvailable for new subscriptions.

See Also:
Subscription.setActive(boolean), Subscription.setActivationTrigger(java.lang.String), Ssp.grantPublicIp(java.lang.String, java.lang.String, java.lang.String), Ssp.addSubscription(java.lang.String, java.lang.String, java.lang.String, java.lang.String), Ssp.deleteSubscription(java.lang.String, java.lang.String, java.lang.String, java.lang.String), Serialized Form

Field Summary
static int ACTIVATE_ONLY
          If getReason() returns this value, this exception occurred because it is not allowed to deactivate an "activateOnly" service.
static int ANONYMOUS_USER
          If getReason() returns this value, this exception occurred because an anonymous user attempted to modify a subscription or add a subbscription or delete a subscription.
static int AUTH_PRECLUDES_ACTIVATE_ON_LOGIN
          If getReason() returns this value, this exception occurred because an attempt was made to make a subscription to a service that requires authentication an activate-on-login subscription.
static int FILTERED_OUT
          If getReason() returns this value, this exception occurred because it is not allowed to activate or deactivate a subscription filtered out by RADIUS auth plug-in through the portal API.
static int INHERITED_SUBSCRIPTION
          If getReason() returns this value, this exception occurred because an attempt was made to alter a subscription that the user inherited from another user profile.
static int INVISIBLE
          If getReason() returns this value, this exception occurred because it is not allowed to activate or deactivate a subscription to a "invisible" service through the portal API.
static int MUTEX_GROUPS
          If getReason() returns this value, this exception occurred because service mutex groups are currently configured to forbid the attempted subscription activation or modification.
static int NO_SESSION_MODIFICATION
          If getReason() returns this value, this exception occurred because it is not allowed to modify an active session of an ISP service.
static int PERSISTENT_ACTIVATION
          If getReason() returns this value, this exception occurred when failed to a add a persistent activation.
static int PUBLIC_IP_AUTHENTICATION
          If getReason() returns this value, this exception occurred because the E-series router failed to authenticate the public IP address credentials that are required for a DHCP user to obtain a public IP address.
static int SERVICE_AUTHORIZATION
          If getReason() returns this value, this exception occurred because a service authorization plug-in forbid the attempted service activation or service session modification.
static int SERVICE_UNAVAILABLE
          If getReason() returns this value, this exception occurred because the service is not currently available for subscription.
static int SUBSCRIPTION_AUTHORIZATION
          If getReason() returns this value, this exception occurred because a subscription authorization plug-in forbid the attempted service self subscription or self unsubscription.
static int TRANSIENT_EXCEPTION
          If getReason() returns this value, this exception occurred when activation or deactivation failed due to a transitory problem.
 
Method Summary
 int getReason()
          Returns the reason code that explains the reason for this exception.
 Subscription getSourceBean()
          Returns the Subscription bean that threw this exception during an attempt to activate or modify a subscription, or null.
 
Methods inherited from class net.juniper.smgt.sae.portal.SspException
getMessage, getWebMessage, setWebMessage
 
Methods inherited from class net.juniper.smgt.sae.portal.PortalException
printStackTrace
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PUBLIC_IP_AUTHENTICATION

public static final int PUBLIC_IP_AUTHENTICATION
If getReason() returns this value, this exception occurred because the E-series router failed to authenticate the public IP address credentials that are required for a DHCP user to obtain a public IP address.

Since:
3.0
See Also:
getReason(), Constant Field Values

MUTEX_GROUPS

public static final int MUTEX_GROUPS
If getReason() returns this value, this exception occurred because service mutex groups are currently configured to forbid the attempted subscription activation or modification.

Since:
3.0
See Also:
getReason(), Constant Field Values

SERVICE_AUTHORIZATION

public static final int SERVICE_AUTHORIZATION
If getReason() returns this value, this exception occurred because a service authorization plug-in forbid the attempted service activation or service session modification. One possible reason for this could be a failure to authenticate service-specific credentials. Call getMessage() to get the reply messages from plug-ins.

Since:
3.0
See Also:
getReason(), SspException.getMessage(), Constant Field Values

ANONYMOUS_USER

public static final int ANONYMOUS_USER
If getReason() returns this value, this exception occurred because an anonymous user attempted to modify a subscription or add a subbscription or delete a subscription. Anonymous users are not allowed to modify their subscriptions or to add or delete them.

Since:
3.0
See Also:
getReason(), Constant Field Values

AUTH_PRECLUDES_ACTIVATE_ON_LOGIN

public static final int AUTH_PRECLUDES_ACTIVATE_ON_LOGIN
If getReason() returns this value, this exception occurred because an attempt was made to make a subscription to a service that requires authentication an activate-on-login subscription. Subscriptions to services that require authentication can not be set to activate on login.

Since:
3.0
See Also:
getReason(), Constant Field Values

INHERITED_SUBSCRIPTION

public static final int INHERITED_SUBSCRIPTION
If getReason() returns this value, this exception occurred because an attempt was made to alter a subscription that the user inherited from another user profile. Users are not allowed to modify inherited subscriptions.

Since:
3.0
See Also:
getReason(), Constant Field Values

SERVICE_UNAVAILABLE

public static final int SERVICE_UNAVAILABLE
If getReason() returns this value, this exception occurred because the service is not currently available for subscription.

Since:
3.0
See Also:
getReason(), Constant Field Values

SUBSCRIPTION_AUTHORIZATION

public static final int SUBSCRIPTION_AUTHORIZATION
If getReason() returns this value, this exception occurred because a subscription authorization plug-in forbid the attempted service self subscription or self unsubscription. One possible reason for this could be a failure to authenticate user-specific credentials. Call getMessage() to get the reply messages from plug-ins.

Since:
3.0
See Also:
getReason(), SspException.getMessage(), Constant Field Values

ACTIVATE_ONLY

public static final int ACTIVATE_ONLY
If getReason() returns this value, this exception occurred because it is not allowed to deactivate an "activateOnly" service.

Since:
4.0
See Also:
getReason(), Constant Field Values

INVISIBLE

public static final int INVISIBLE
If getReason() returns this value, this exception occurred because it is not allowed to activate or deactivate a subscription to a "invisible" service through the portal API.

Since:
4.0
See Also:
getReason(), Constant Field Values

FILTERED_OUT

public static final int FILTERED_OUT
If getReason() returns this value, this exception occurred because it is not allowed to activate or deactivate a subscription filtered out by RADIUS auth plug-in through the portal API.

Since:
4.1
See Also:
getReason(), Constant Field Values

NO_SESSION_MODIFICATION

public static final int NO_SESSION_MODIFICATION
If getReason() returns this value, this exception occurred because it is not allowed to modify an active session of an ISP service.

Since:
4.1
See Also:
getReason(), Constant Field Values

TRANSIENT_EXCEPTION

public static final int TRANSIENT_EXCEPTION
If getReason() returns this value, this exception occurred when activation or deactivation failed due to a transitory problem.

Since:
6.0
See Also:
getReason(), Constant Field Values

PERSISTENT_ACTIVATION

public static final int PERSISTENT_ACTIVATION
If getReason() returns this value, this exception occurred when failed to a add a persistent activation.

Since:
6.2.0
See Also:
getReason(), Constant Field Values
Method Detail

getSourceBean

public Subscription getSourceBean()
Returns the Subscription bean that threw this exception during an attempt to activate or modify a subscription, or null.

Returns:
Null, if this exception was thrown due to a failure to authenticate public IP address credentials during a call to Ssp.grantPublicIp. In this case, no subscription is involved.

getReason

public int getReason()
Returns the reason code that explains the reason for this exception.

Returns:
One of the int constants defined in this class.
Since:
3.0

Core API 7.6