org.mitre.data.AbstractPageOperationTemplate< T > クラステンプレート

org.mitre.data.AbstractPageOperationTemplate< T > 連携図

公開メンバ関数
	AbstractPageOperationTemplate (String operationName)
	AbstractPageOperationTemplate (int maxPages, long maxTime, String operationName)
void	execute ()
abstract Collection< T >	fetchPage ()
int	getMaxPages ()
void	setMaxPages (int maxPages)
long	getMaxTime ()
void	setMaxTime (long maxTime)
boolean	isSwallowExceptions ()
void	setSwallowExceptions (boolean swallowExceptions)
String	getOperationName ()
void	setOperationName (String operationName)

限定公開メンバ関数
abstract void	doOperation (T item)
void	finalReport (int operationsCompleted, int exceptionsSwallowedCount, Set< String > exceptionsSwallowedClasses)

非公開変数類
int	maxPages
long	maxTime
boolean	swallowExceptions = true
String	operationName = ""

静的非公開変数類
static final Logger	logger = LoggerFactory.getLogger(AbstractPageOperationTemplate.class)
static int	DEFAULT_MAX_PAGES = 1000
static long	DEFAULT_MAX_TIME_MILLIS = 600000L

詳解

Abstract class for performing an operation on a potentially large number of items by paging through the items in discreet chunks.

引数

<T>	the type parameter

著者

Colm Smyth.

構築子と解体子

AbstractPageOperationTemplate() [1/2]

org.mitre.data.AbstractPageOperationTemplate< T >.AbstractPageOperationTemplate ( String  operationName )

inline

default constructor which sets the value of maxPages and maxTime to DEFAULT_MAX_PAGES and DEFAULT_MAX_TIME_MILLIS respectively

                                                                  {
                this(DEFAULT_MAX_PAGES, DEFAULT_MAX_TIME_MILLIS, operationName);
        }

AbstractPageOperationTemplate() [2/2]

org.mitre.data.AbstractPageOperationTemplate< T >.AbstractPageOperationTemplate ( int  maxPages, long  maxTime, String  operationName  )

inline

Instantiates a new AbstractPageOperationTemplate with the given maxPages and maxTime

引数

maxPages	the maximum number of pages to fetch.
maxTime	the maximum execution time.

                                                                                              {
                this.maxPages = maxPages;
                this.maxTime = maxTime;
                this.operationName = operationName;
        }

関数詳解

doOperation()

abstract void org.mitre.data.AbstractPageOperationTemplate< T >.doOperation ( T  item )

abstractprotected

method responsible for performing desired operation on a fetched page item.

引数

item

the item

execute()

void org.mitre.data.AbstractPageOperationTemplate< T >.execute ( )

inline

Execute the operation on each member of a page of results retrieved through the fetch method. the method will execute until either the maxPages or maxTime limit is reached or until the fetch method returns no more results. Exceptions thrown performing the operation on the item will be swallowed if the swallowException (default true) field is set true.

                             {
                logger.debug("[" + getOperationName() +  "] Starting execution of paged operation. maximum time: " + maxTime + ", maximum pages: " + maxPages);

                long startTime = System.currentTimeMillis();
                long executionTime = 0;
                int i = 0;

                int exceptionsSwallowedCount = 0;
                int operationsCompleted = 0;
                Set<String> exceptionsSwallowedClasses = new HashSet<String>();


                while (i< maxPages && executionTime < maxTime){
                        Collection<T> page = fetchPage();
                        if(page == null || page.size() == 0){
                                break;
                        }

                        for (T item : page) {
                                try {
                                        doOperation(item);
                                        operationsCompleted++;
                                } catch (Exception e){
                                        if(swallowExceptions){
                                                exceptionsSwallowedCount++;
                                                exceptionsSwallowedClasses.add(e.getClass().getName());
                                                logger.debug("Swallowing exception " + e.getMessage(), e);
                                        } else {
                                                logger.debug("Rethrowing exception " + e.getMessage());
                                                throw e;
                                        }
                                }
                        }

                        i++;
                        executionTime = System.currentTimeMillis() - startTime;
                }

                finalReport(operationsCompleted, exceptionsSwallowedCount, exceptionsSwallowedClasses);
        }

fetchPage()

abstract Collection<T> org.mitre.data.AbstractPageOperationTemplate< T >.fetchPage ( )

abstract

method responsible for fetching a page of items.

戻り値

the collection of items

finalReport()

void org.mitre.data.AbstractPageOperationTemplate< T >.finalReport ( int  operationsCompleted, int  exceptionsSwallowedCount, Set< String >  exceptionsSwallowedClasses  )

inlineprotected

Method responsible for final report of progress.

戻り値

                                                                                                                                  {
                if (operationsCompleted > 0 || exceptionsSwallowedCount > 0) {
                        logger.info("[" + getOperationName() +  "] Paged operation run: completed " + operationsCompleted + "; swallowed " + exceptionsSwallowedCount + " exceptions");
                }
                for(String className:  exceptionsSwallowedClasses) {
                        logger.warn("[" + getOperationName() +  "] Paged operation swallowed at least one exception of type " + className);
                }
        }

getMaxPages()

int org.mitre.data.AbstractPageOperationTemplate< T >.getMaxPages ( )

inline

                                 {
                return maxPages;
        }

getMaxTime()

long org.mitre.data.AbstractPageOperationTemplate< T >.getMaxTime ( )

inline

                                 {
                return maxTime;
        }

getOperationName()

String org.mitre.data.AbstractPageOperationTemplate< T >.getOperationName ( )

inline

戻り値

the operationName

                                         {
                return operationName;
        }

isSwallowExceptions()

boolean org.mitre.data.AbstractPageOperationTemplate< T >.isSwallowExceptions ( )

inline

                                             {
                return swallowExceptions;
        }

setMaxPages()

void org.mitre.data.AbstractPageOperationTemplate< T >.setMaxPages ( int  maxPages )

inline

                                              {
                this.maxPages = maxPages;
        }

setMaxTime()

void org.mitre.data.AbstractPageOperationTemplate< T >.setMaxTime ( long  maxTime )

inline

                                             {
                this.maxTime = maxTime;
        }

setOperationName()

void org.mitre.data.AbstractPageOperationTemplate< T >.setOperationName ( String  operationName )

inline

引数

operationName

the operationName to set

                                                           {
                this.operationName = operationName;
        }

setSwallowExceptions()

void org.mitre.data.AbstractPageOperationTemplate< T >.setSwallowExceptions ( boolean  swallowExceptions )

inline

                                                                    {
                this.swallowExceptions = swallowExceptions;
        }

メンバ詳解

DEFAULT_MAX_PAGES

int org.mitre.data.AbstractPageOperationTemplate< T >.DEFAULT_MAX_PAGES = 1000

staticprivate

DEFAULT_MAX_TIME_MILLIS

long org.mitre.data.AbstractPageOperationTemplate< T >.DEFAULT_MAX_TIME_MILLIS = 600000L

staticprivate

logger

final Logger org.mitre.data.AbstractPageOperationTemplate< T >.logger = LoggerFactory.getLogger(AbstractPageOperationTemplate.class)

staticprivate

maxPages

int org.mitre.data.AbstractPageOperationTemplate< T >.maxPages

private

int specifying the maximum number of pages which should be fetched before execution should terminate

maxTime

long org.mitre.data.AbstractPageOperationTemplate< T >.maxTime

private

long specifying the maximum execution time in milliseconds

operationName

String org.mitre.data.AbstractPageOperationTemplate< T >.operationName = ""

private

String that is used for logging in final tallies.

swallowExceptions

boolean org.mitre.data.AbstractPageOperationTemplate< T >.swallowExceptions = true

private

boolean specifying whether or not Exceptions incurred performing the operation should be swallowed during execution default true.

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/OpenId/mitreid-connect/src/openid-connect-common/src/main/java/org/mitre/data/AbstractPageOperationTemplate.java