com.bea.wcp.diameter.sh

Class AccessKey

java.lang.Object

com.bea.wcp.diameter.sh.AccessKey

public final class AccessKey
extends Object

Access key used for Sh-Pull, Sh-Update, and Sh-Subs-Notif commands. Can be parsed from string-based document selector of the following format: sh://;[/] where is the user's public or MSISDN identifier, and is the data reference type, and is the optional data reference parameter.

Author:

Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFIX

Constructor Summary

Constructors

Constructor and Description
AccessKey(String selector) Parses AccessKey from specified document selector.
AccessKey(UserIdentity userId, DataReference dataRef)
AccessKey(UserIdentity userId, DataReference dataRef, Object param)

Method Summary

Modifier and Type	Method and Description
void	addAvps(AvpList avps) Adds the appropriate AVPs for this AccessKey to the specified list of AVPs.
boolean	equals(Object obj)
static AccessKey	getAccessKey(Request req, Object param) Returns the AccessKey for the specified Sh request.
DataReference	getDataReference() Returns the DataReference for this AccessKey.
Object	getParameter() Returns the optional parameter for this AccessKey.
UserIdentity	getUserIdentity() Returns the UserIdentity for this AccessKey.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

Constructor Detail

AccessKey

public AccessKey(UserIdentity userId,
                 DataReference dataRef,
                 Object param)

AccessKey

public AccessKey(UserIdentity userId,
                 DataReference dataRef)

AccessKey

public AccessKey(String selector)

Parses AccessKey from specified document selector.

Throws:

IllegalArgumentException - if the document selector was invalid

Method Detail

getUserIdentity

public UserIdentity getUserIdentity()

Returns the UserIdentity for this AccessKey.

getDataReference

public DataReference getDataReference()

Returns the DataReference for this AccessKey.

getParameter

public Object getParameter()

Returns the optional parameter for this AccessKey.

addAvps

public void addAvps(AvpList avps)

Adds the appropriate AVPs for this AccessKey to the specified list of AVPs.

Parameters:

avps - the AVPs for the message

getAccessKey

public static AccessKey getAccessKey(Request req,
                                     Object param)
                              throws AvpException

Returns the AccessKey for the specified Sh request.

Parameters:

req - the Sh request

param - ignore parameter AVP and use specified param instead

Returns:

the AccessKey

Throws:

AvpException - if one or more AVPs in the request were invalid

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object